diff --git a/README.md b/README.md index 7c9e372..7764b89 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Geant4.jl-tutorial +`# Geant4.jl-tutorial Materials for the Geant4.jl Tutorial. 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 [![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) ## Follow the tutorial on a local computer: -To install all what is needed: +You need to install julia and jupyter in your system. These are the instructions: +### Linux or MacOS ```bash # install Julia curl -fsSL https://install.julialang.org | sh @@ -23,9 +24,27 @@ julia -e 'using IJulia; installkernel("Julia")' julia -e 'using IJulia; jupyterlab(dir="tutorial/docs")' ``` +### Windows +```cmd +REM install Julia from Microsoft Store +winget install julia -s msstore + +REM or using the Windows Julia installed from https://julialang.org/downloads/ +REM make sure that julia is added to the PATH + +REM clone the tutorial repository +git clone https://github.com/peremato/Geant4.jl-tutorial.git +cd Geant4.jl-tutorial + +REM instantiate this project and install jupyter +set JULIA_PROJECT=@. +julia -e "using Pkg;Pkg.instantiate()" +julia -e "using IJulia; installkernel(\"Julia\")" +julia -e "using IJulia; jupyterlab(dir=\"tutorial/docs\")" +``` - - - When not taken from other sources (with its own Copyright and License), this material is: Copyright © 2023 CERN and the authors / contributors. -Licensed under [CC-BY-4.0](./LICENSE). \ No newline at end of file +Licensed under [CC-BY-4.0](./LICENSE).` \ No newline at end of file