Skip to content

Commit c2d851e

Browse files
committed
Added windows instructions
1 parent 9224122 commit c2d851e

File tree

1 file changed

+22
-3
lines changed

1 file changed

+22
-3
lines changed

README.md

+22-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Geant4.jl-tutorial
1+
`# Geant4.jl-tutorial
22
Materials for the Geant4.jl Tutorial.
33

44
Read the rendered Jupyter book: https://peremato.github.io/Geant4.jl-tutorial/index.html
@@ -7,7 +7,8 @@ Read the rendered Jupyter book: https://peremato.github.io/Geant4.jl-tutorial/in
77
[![Binder](https://binderhub.ssl-hep.org/badge_logo.svg)](https://binderhub.ssl-hep.org/v2/gh/peremato/Geant4.jl-tutorial/HEAD?labpath=tutorial%2Fdocs%2F01-introduction.ipynb)
88

99
## Follow the tutorial on a local computer:
10-
To install all what is needed:
10+
You need to install julia and jupyter in your system. These are the instructions:
11+
### Linux or MacOS
1112
```bash
1213
# install Julia
1314
curl -fsSL https://install.julialang.org | sh
@@ -23,9 +24,27 @@ julia -e 'using IJulia; installkernel("Julia")'
2324
julia -e 'using IJulia; jupyterlab(dir="tutorial/docs")'
2425
```
2526

27+
### Windows
28+
```cmd
29+
REM install Julia from Microsoft Store
30+
winget install julia -s msstore
31+
32+
REM or using the Windows Julia installed from https://julialang.org/downloads/
33+
REM make sure that julia is added to the PATH
34+
35+
REM clone the tutorial repository
36+
git clone https://github.com/peremato/Geant4.jl-tutorial.git
37+
cd Geant4.jl-tutorial
38+
39+
REM instantiate this project and install jupyter
40+
set JULIA_PROJECT=@.
41+
julia -e "using Pkg;Pkg.instantiate()"
42+
julia -e "using IJulia; installkernel(\"Julia\")"
43+
julia -e "using IJulia; jupyterlab(dir=\"tutorial/docs\")"
44+
```
2645
- - -
2746
When not taken from other sources (with its own Copyright and License), this material is:
2847

2948
Copyright © 2023 CERN and the authors / contributors.
3049

31-
Licensed under [CC-BY-4.0](./LICENSE).
50+
Licensed under [CC-BY-4.0](./LICENSE).`

0 commit comments

Comments
 (0)