From f72f954636507bb0aeb16d04a5a5750998a1bcad Mon Sep 17 00:00:00 2001
From: Michele Nottoli <michele.nottoli@gmail.com>
Date: Tue, 10 Oct 2023 14:02:58 +0200
Subject: [PATCH] Further update.
---
0_Installation.ipynb | 38 +++++++++++++++++++++++++++-----------
README.md | 19 +++++++++++++------
2 files changed, 40 insertions(+), 17 deletions(-)
diff --git a/0_Installation.ipynb b/0_Installation.ipynb
index 652a3b4..36cfaf4 100644
--- a/0_Installation.ipynb
+++ b/0_Installation.ipynb
@@ -22,7 +22,7 @@
"metadata": {},
"source": [
"## Software and material\n",
- "What you need for the workshop (quick overview):\n",
+ "What you need for the workshop (quick overview, step by step instructions are given later):\n",
"\n",
"- [Julia 1.9](https://julialang.org/downloads/)\n",
"- [Jupyter](https://jupyter.org/) and [IJulia.jl](https://github.com/JuliaLang/IJulia.jl)\n",
@@ -34,11 +34,18 @@
"Julia can be easily obtained in binary form from [Julia downloads](https://julialang.org/downloads/).\n",
"\n",
"### Getting all the rest\n",
- "The easiest way to get the remaining files and dependencies\n",
- "is to [download the install.jl script](https://gitlab.mathematik.uni-stuttgart.de/stammbn/julia-seminar/-/blob/main/install.jl?ref_type=heads) and run it from julia. See the instructions [on the github repository](https://gitlab.mathematik.uni-stuttgart.de/stammbn/julia-seminar/).\n",
"\n",
- "As an alternative you can also also run the following commands manually\n",
- "(this requires to have `git` and `julia` available from the commandline):\n",
+ "To get the remaining files and dependencies start up `julia` and in the resulting REPL shell, copy and paste the following:\n",
+ "```julia\n",
+ "import Downloads\n",
+ "script = Downloads.download(\"https://gitlab.mathematik.uni-stuttgart.de/stammbn/julia-seminar/-/raw/main/install.jl?ref_type=heads\")\n",
+ "include(script)\n",
+ "```\n",
+ "This [downloads the install.jl script](https://gitlab.mathematik.uni-stuttgart.de/stammbn/julia-seminar/-/raw/main/install.jl?ref_type=heads) and runs it from julia.\n",
+ "\n",
+ "### Getting all the rest (alternative version)\n",
+ "\n",
+ "As an alternative you can also also run the following commands manually (this requires to have `git` and `julia` available from the commandline): \n",
"```\n",
"git clone https://gitlab.mathematik.uni-stuttgart.de/stammbn/Julia-seminar/\n",
"cd Julia-seminar\n",
@@ -65,7 +72,7 @@
"metadata": {},
"source": [
"## Software und Material\n",
- "Was du für das Seminar brauchst (schneller Überblick):\n",
+ "Was du für das Seminar benötigst (schneller Überblick, detaillierte Anweisungen werden später gegeben):\n",
"\n",
"- [Julia 1.9](https://julialang.org/downloads/)\n",
"- [Jupyter](https://jupyter.org/) und [IJulia.jl](https://github.com/JuliaLang/IJulia.jl)\n",
@@ -73,14 +80,22 @@
"- Alle benötigten Abhängigkeiten (Julia-Pakete) für das Seminar\n",
"\n",
"### Julia herunterladen\n",
- "Um dem Kurs zu folgen, benötigen Sie **Julia 1.9**.\n",
+ "Um dem Kurs zu folgen, benötigst du **Julia 1.9**.\n",
"Julia kann leicht in binärer Form von den [Julia-Downloads](https://julialang.org/downloads/) bezogen werden.\n",
"\n",
"### Alles andere herunterladen\n",
- "Die einfachste Möglichkeit, die verbleibenden Dateien und Abhängigkeiten zu erhalten, ist das [install.jl-Skript herunterzuladen](https://gitlab.mathematik.uni-stuttgart.de/stammbn/julia-seminar/-/blob/main/install.jl?ref_type=heads) und es von Julia auszuführen. Siehe die Anweisungen [im GitHub-Repository](https://gitlab.mathematik.uni-stuttgart.de/stammbn/julia-seminar/).\n",
"\n",
- "Alternativ kannst du auch die folgenden Befehle manuell ausführen\n",
- "(dies setzt voraus, dass `git` und `julia` von der Kommandozeile aus verfügbar sind):\n",
+ "Um die verbleibenden Dateien und Abhängigkeiten zu erhalten, starte `julia` und kopiere im resultierenden REPL-Shell folgenden Code:\n",
+ "```julia\n",
+ "import Downloads\n",
+ "script = Downloads.download(\"https://gitlab.mathematik.uni-stuttgart.de/stammbn/julia-seminar/-/raw/main/install.jl?ref_type=heads\")\n",
+ "include(script)\n",
+ "```\n",
+ "Das [lädt das install.jl-Skript herunter](https://gitlab.mathematik.uni-stuttgart.de/stammbn/julia-seminar/-/raw/main/install.jl?ref_type=heads) und führt es in Julia aus.\n",
+ "\n",
+ "### Den Rest bekommen (alternative Version)\n",
+ "\n",
+ "Als Alternative können Sie auch die folgenden Befehle manuell ausführen (dies setzt voraus, dass `git` und `julia` von der Kommandozeile aus verfügbar sind):\n",
"```\n",
"git clone https://gitlab.mathematik.uni-stuttgart.de/stammbn/Julia-seminar/\n",
"cd Julia-seminar\n",
@@ -89,13 +104,14 @@
"\n",
"### Starten des Notebooks\n",
"Um das Notebook zu starten, stellen Sie sicher, dass Sie sich im Ordner `Julia-seminar` befinden, und führen Sie dann `julia` aus: Eine interaktive Julia-Befehlszeile wird geöffnet. Führen Sie darin folgenden Befehl aus:\n",
+ "\n",
"```\n",
"using IJulia; notebook(dir=pwd())\n",
"```\n",
"und das Notebook wird automatisch im Browser geöffnet.\n",
"\n",
"### Fehlerbehebung\n",
- "Wenn du auf Probleme stößt, schau dir den [ausgezeichneten Abschnitt zur Fehlerbehebung](https://carstenbauer.github.io/WorkshopWizard.jl/dev/troubleshooting/) des WorkshopWizard-Pakets von Carsten Bauer an (das von `install.jl` verwendet wird)."
+ "Wenn Sie auf Probleme stoßen, werfen Sie einen Blick auf den [ausgezeichneten Problembehandlungsabschnitt](https://carstenbauer.github.io/WorkshopWizard.jl/dev/troubleshooting/) aus dem WorkshopWizard-Paket von Carsten Bauer (das von `install.jl` verwendet wird)."
]
},
{
diff --git a/README.md b/README.md
index ed95335..f6408fb 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@ The course material is adapted from two sources:
- the book [ThinkJulia](https://benlauwens.github.io/ThinkJulia.jl/latest/book.html) from Allen Downey and Ben Lauwens ([Creative Commons Attribution-NonCommercial 3.0 Unported license](https://creativecommons.org/licenses/by-nc/3.0/deed.en)).
## Software and material
-What you need for the workshop (quick overview):
+What you need for the workshop (quick overview, step by step instructions are given later):
- [Julia 1.9](https://julialang.org/downloads/)
- [Jupyter](https://jupyter.org/) and [IJulia.jl](https://github.com/JuliaLang/IJulia.jl)
@@ -18,11 +18,18 @@ For following the course you will need **Julia 1.9**.
Julia can be easily obtained in binary form from [Julia downloads](https://julialang.org/downloads/).
### Getting all the rest
-The easiest way to get the remaining files and dependencies
-is to [download the install.jl script](https://gitlab.mathematik.uni-stuttgart.de/stammbn/julia-seminar/-/blob/main/install.jl?ref_type=heads) and run it from julia. See the instructions [on the github repository](https://gitlab.mathematik.uni-stuttgart.de/stammbn/julia-seminar/).
-As an alternative you can also also run the following commands manually
-(this requires to have `git` and `julia` available from the commandline):
+To get the remaining files and dependencies start up `julia` and in the resulting REPL shell, copy and paste the following:
+```julia
+import Downloads
+script = Downloads.download("https://gitlab.mathematik.uni-stuttgart.de/stammbn/julia-seminar/-/raw/main/install.jl?ref_type=heads")
+include(script)
+```
+This [downloads the install.jl script](https://gitlab.mathematik.uni-stuttgart.de/stammbn/julia-seminar/-/raw/main/install.jl?ref_type=heads) and runs it from julia.
+
+### Getting all the rest (alternative version)
+
+As an alternative you can also also run the following commands manually (this requires to have `git` and `julia` available from the commandline):
```
git clone https://gitlab.mathematik.uni-stuttgart.de/stammbn/Julia-seminar/
cd Julia-seminar
@@ -42,7 +49,7 @@ If you are facing issues, check out
the [great troubleshooting section](https://carstenbauer.github.io/WorkshopWizard.jl/dev/troubleshooting/)
from the WorkshopWizard package by Carsten Bauer (which is being used by `install.jl`).
-### For Developers: Setting Up `pre-commit`
+## For Developers: Setting Up `pre-commit`
[`pre-commit`](https://pre-commit.com/) is a framework that helps to manage and maintain pre-commit hooks to ensure that your code adheres to a consistent style, prevents errors, and adheres to other quality assurance checks.
--
GitLab