Improve windows installation instructions (#37)

* Remove $ from commands as it's irritating for new users and also doesn't aid copying. * Add note for up-to-date system. Windows broke the Explorer's right click -> Open in Terminal functionality in an older version. * Fix some spelling mistakes * windows: switch to instructions using scoop * Add some notes for common error messages for ki * remove references to kotlinc as it's installable in windoof now * fix formatting --------- Co-authored-by: Rdeisenroth <[email protected]>
d120 · Oct 2, 2023 · 86045dc · 86045dc
1 parent 96d6dff
commit 86045dc
Show file tree

Hide file tree

Showing 4 changed files with 104 additions and 61 deletions.
diff --git a/exercises/Aufgabe1.tex b/exercises/Aufgabe1.tex
@@ -18,7 +18,7 @@
         Folgt denen, sodass ihr Kotlin ausführen könnt.
         \begin{solution}
             Kotlin ist installiert und dem Pfad hinzugefügt. Der Befehl
-            {\ttfamily kotlinc -version} gibt eine Versionsnummer von mindestens {\ttfamily 1.8.22} aus.
+            {\ttfamily kotlin -version} gibt eine Versionsnummer von mindestens {\ttfamily 1.8.22} aus.
             % Der Kotlin Interpreter mit {\ttfamily kotlin} wurde gestartet.
 
             Das Repl wurde korrekt installiert und mit {\ttfamily ki} gestartet. Der Befehl

diff --git a/lecture/01_Einfuehrung/01_Einfuehrung.tex b/lecture/01_Einfuehrung/01_Einfuehrung.tex
@@ -243,13 +243,13 @@ \section{Vom Quelltext zum fertigen Programm}
                 \node[fill=lightpetrol,draw, inner sep=5pt,rounded rectangle] (file) at (0,-1.8) {helloworld.kts};
                 \draw[->,line width=.6mm] (mensch.south) -- (file.north);
 
-                \node[fill=lightpetrol,draw, inner sep=5pt,rounded rectangle] (kotlin) at (0,-4) {\texttt{kotlinc -script helloworld.kts}};
+                \node[fill=lightpetrol,draw, inner sep=5pt,rounded rectangle] (kotlin) at (0,-4) {\texttt{kotlin helloworld.kts}};
                 \draw[->,line width=.6mm] (file.south) -- (kotlin.north);
             \end{tikzpicture}
         \end{column}
         \begin{column}{.6\textwidth}
             \begin{itemize}
-                \item Ausführen: \texttt{kotlinc -script dateiName.kts}
+                \item Ausführen: \texttt{kotlin dateiName.kts}
                 \item Kotlin-Programme laufen überall, wo Kotlin installiert ist
             \end{itemize}
             \begin{block}{Hinweis}
@@ -300,7 +300,7 @@ \section{Ein Kotlin-Programm ausführen}
     \slidehead
     % \begin{noindent}
     \begin{commandshell}
-@\shellprefix@ kotlinc -script HelloWorld.kts
+@\shellprefix@ kotlin HelloWorld.kts
 Hello World!
 @\shellprefix\shellcursor@
     \end{commandshell}

diff --git a/misc/linux_commands/KotlinInstallieren.tex b/misc/linux_commands/KotlinInstallieren.tex
@@ -10,15 +10,52 @@
 \begin{document}
 \maketitle
 
+Bitte schaue vorher, dass dein System auf dem aktuellen Stand ist.
 
 In dieser Installationsanleitung installieren wir:
 \begin{itemize}
     \item Kotlin version 1.9
-    \item Java Jdk 17 (wird für Kotlin benötigt)
+    \item Java JDK 11+ (wird für Kotlin benötigt)
     \item \href{https://github.com/Kotlin/kotlin-interactive-shell}{ki (\underline{K}otlin \underline{I}nteractive-Shell)}
 \end{itemize}
 \section*{Windows}
-% \subsection*{Komanndozeile öffnen (Powershell)}
+\subsection*{Automatische Installation durch scoop}
+\subsubsection*{Terminal öffnen (Powershell)}
+Siehe Terminal Guide
+\subsubsection*{Scoop installieren}
+Anhand der Anleitung auf \url{https://scoop.sh/} folgendes ins Terminal eingeben und nach jeder Zeile Enter drücken:
+%\begin{noindent}
+\begin{commandshell}
+@\shellprefix{}@Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
+@\shellprefix{}@irm get.scoop.sh | iex
+@\shellprefix{}@scoop install git
+\end{commandshell}
+%\end{noindent}
+\subsubsection*{Java installieren}
+Als Erstes kannst du mit folgendem Befehl überprüfen, ob du Java installiert hast:
+\begin{commandshell}
+    @\shellprefix{}@javac -version
+\end{commandshell}
+Wenn mindestens Version 11 angezeigt wird, hast du eine ausreichend aktuelle Version. Wir empfehlen aber in allen Fällen die neuste Version mit den folgenden Befehlen zu installieren:
+%\begin{noindent}
+\begin{commandshell}
+@\shellprefix{}@scoop bucket add java
+@\shellprefix{}@scoop install java/openjdk
+\end{commandshell}
+%\end{noindent}
+\subsubsection*{Kotlin installieren}
+\begin{commandshell}
+    @\shellprefix{}@scoop install main/kotlin
+\end{commandshell}
+\subsubsection*{Kotlin Interactive Shell installieren}
+%\begin{noindent}
+\begin{commandshell}
+@\shellprefix{}@scoop bucket add extras
+@\shellprefix{}@scoop install extras/kotlin-interactive-shell
+\end{commandshell}
+%\end{noindent}
+Nun kannst du die Installation überprüfen (siehe Abschnitt \nameref{sec:check}).
+% \subsection*{Kommandozeile öffnen (Powershell)}
 % Siehe Terminal guide
 % \subsection*{Automatische Installation durch Winget}
 % \begin{hinweis}
@@ -30,59 +67,59 @@ \section*{Windows}
 %             @\shellprefix{}@java -version
 %         \end{commandshell}
 %         Wenn die Rückgabe sowas wie \verb+java version "17.0.1"+ ist, hast du bereits eine JDK installiert. In diesem Fall kannst du die JDK-Installation überspringen. Für die aktuelle Kotlin Version wird mindestens JDK-Version 17 benötigt.
-%     \item Gebe in der Powershell den folgenden Befehl ein und drücke Enter\footnote{Befehl generiert mit \url{https://winstall.app/apps/JetBrains.Kotlin.Complier}}:
+%     \item Gebe in der Powershell den folgenden Befehl ein und drücke Enter\footnote{Befehl generiert mit \url{https://winstall.app/apps/JetBrains.Kotlin.Compiler}}:
 %         \begin{commandshell}
 %             @\shellprefix{}@winget install --id=EclipseAdoptium.Temurin.17.JDK -e
 %         \end{commandshell}
 %     \item Wenn verlangt wird, dass du die Nutzungsbedingungen akzeptierst, drücke \texttt{y} und Enter
 %     \item Warte, bis die Installation abgeschlossen ist
-%     \item Als nächstes installieren wir den Kotlin Compiler. Gebe dazu den folgenden Befehl ein und drücke Enter\footnote{Befehl generiert mit \url{https://winstall.app/apps/JetBrains.Kotlin.Complier}}:
+%     \item Als nächstes installieren wir den Kotlin Compiler. Gebe dazu den folgenden Befehl ein und drücke Enter\footnote{Befehl generiert mit \url{https://winstall.app/apps/JetBrains.Kotlin.Compiler}}:
 %         \begin{commandshell}
-%             @\shellprefix{}@winget install --id=JetBrains.Kotlin.Complier -e
+%             @\shellprefix{}@winget install --id=JetBrains.Kotlin.Compiler -e
 %         \end{commandshell}
 %     \item Damit die neuen Befehle erkannnt werden, musst du die Kommandozeile neu starten, also einmal schließen und wieder öffnen.
 %     \item Überprüfe die Installation (siehe Abschnitt \nameref{sec:check})
 % \end{itemize}
-\subsection*{Automatische Installation durch Chocolatey}
-\subsubsection*{Chocolatey installieren}
-\begin{itemize}
-    \item Falls chocolatey schon installiert ist, kannst du diesen Schritt überspringen
-    \item Gebe in der Powershell den folgenden Befehl ein und drücke Enter\footnote{Befehl generiert mit \url{https://chocolatey.org/install}} (da der Befehl sich nicht gut kopieren lässt am Besten aus dem Link der Fußnote kopieren):
-        \begin{commandshell}
-            @\shellprefix{}@Set-ExecutionPolicy Bypass -Scope Process -Force;
-            [System.Net.ServicePointManager]::SecurityProtocol =
-            [System.Net.ServicePointManager]::SecurityProtocol -bor 3072;
-            iex ((New-Object System.Net.WebClient)
-            .DownloadString('https://community.chocolatey.org/install.ps1'))
-        \end{commandshell}
-    \item Warte, bis die Installation abgeschlossen ist
-\end{itemize}
-\begin{hinweis}
-    Ab Windows 10 kann chocolatey auch über winget per \texttt{winget install chocolatey} installiert werden.
-\end{hinweis}
-\clearpage
-\subsubsection*{JVM und Kotlin Compiler durch Chocolatey installieren}
-\begin{itemize}
-    \item Gebe in der Powershell den folgenden Befehl ein und drücke Enter\footnote{siehe auch \url{https://community.chocolatey.org/packages/kotlinc} und \url{https://community.chocolatey.org/packages/Temurin17/}}:
-        \begin{commandshell}
-            @\shellprefix{}@choco install temurin17 kotlinc -y
-        \end{commandshell}
-    \item Warte, bis die Installation abgeschlossen ist
-    \item Damit die neuen Befehle erkannnt werden, musst du die Kommandozeile neu starten, also einmal schließen und wieder öffnen.
-    \item Überprüfe die Installation (siehe Abschnitt \nameref{sec:check})
-\end{itemize}
-\subsubsection{ki}
-Aktuell gibt es leider keinen \enquote{schönen} Weg, \texttt{ki} über einen Paketmanager zu installieren. Stattdessen kannst du \texttt{ki} lokal installieren. Dazu musst du folgende Schritte ausführen:
-\begin{itemize}
-    \item Lade KI von hier herunter \url{https://github.com/Kotlin/kotlin-interactive-shell/releases/tag/v0.5.2}
-    \item Entpacke die Datei in einen Ordner deiner Wahl.
-    \item Gehe nun in den bin-Ordner der entpackten Datei und öffne dort ein Terminal. (Siehe Terminal-Anleitung)
-    \item Es kann sein, dass du statt dem Befehl \texttt{ki} den Befehl \mintinline{text}{.\ki.bat} ausführen musst.
-    \item Überprüfe die Installation (siehe Abschnitt \nameref{sec:check})
-\end{itemize}
-\begin{hinweis}
-    Diese Installation funktioniert nur, solange sich deine Komandozeile im bin-Ordner befindet. Wenn du die Komandozeile schließt, musst du beim nächsten öffnen erneut in den bin-Ordner wechseln.
-\end{hinweis}
+% \subsection*{Automatische Installation durch Chocolatey}
+% \subsubsection*{Chocolatey installieren}
+% \begin{itemize}
+%     \item Falls chocolatey schon installiert ist, kannst du diesen Schritt überspringen
+%     \item Gebe in der Powershell den folgenden Befehl ein und drücke Enter\footnote{Befehl generiert mit \url{https://chocolatey.org/install}} (da der Befehl sich nicht gut kopieren lässt am Besten aus dem Link der Fußnote kopieren):
+%         \begin{commandshell}
+%             @\shellprefix{}@Set-ExecutionPolicy Bypass -Scope Process -Force;
+%             [System.Net.ServicePointManager]::SecurityProtocol =
+%             [System.Net.ServicePointManager]::SecurityProtocol -bor 3072;
+%             iex ((New-Object System.Net.WebClient)
+%             .DownloadString('https://community.chocolatey.org/install.ps1'))
+%         \end{commandshell}
+%     \item Warte, bis die Installation abgeschlossen ist
+% \end{itemize}
+% \begin{hinweis}
+%     Ab Windows 10 kann chocolatey auch über winget per \texttt{winget install chocolatey} installiert werden.
+% \end{hinweis}
+% \clearpage
+% \subsubsection*{JVM und Kotlin Compiler durch Chocolatey installieren}
+% \begin{itemize}
+%     \item Gebe in der Powershell den folgenden Befehl ein und drücke Enter\footnote{siehe auch \url{https://community.chocolatey.org/packages/kotlinc} und \url{https://community.chocolatey.org/packages/Temurin17/}}:
+%         \begin{commandshell}
+%             @\shellprefix{}@choco install temurin17 kotlinc -y
+%         \end{commandshell}
+%     \item Warte, bis die Installation abgeschlossen ist
+%     \item Damit die neuen Befehle erkannnt werden, musst du die Kommandozeile neu starten, also einmal schließen und wieder öffnen.
+%     \item Überprüfe die Installation (siehe Abschnitt \nameref{sec:check})
+% \end{itemize}
+% \subsubsection{ki}
+% Aktuell gibt es leider keinen \enquote{schönen} Weg, \texttt{ki} über einen Paketmanager zu installieren. Stattdessen kannst du \texttt{ki} lokal installieren. Dazu musst du folgende Schritte ausführen:
+% \begin{itemize}
+%     \item Lade KI von hier herunter \url{https://github.com/Kotlin/kotlin-interactive-shell/releases/tag/v0.5.2}
+%     \item Entpacke die Datei in einen Ordner deiner Wahl.
+%     \item Gehe nun in den bin-Ordner der entpackten Datei und öffne dort ein Terminal. (Siehe Terminal-Anleitung)
+%     \item Es kann sein, dass du statt dem Befehl \texttt{ki} den Befehl \mintinline{text}{.\ki.bat} ausführen musst.
+%     \item Überprüfe die Installation (siehe Abschnitt \nameref{sec:check})
+% \end{itemize}
+% \begin{hinweis}
+%     Diese Installation funktioniert nur, solange sich deine Kommandozeile im bin-Ordner befindet. Wenn du die Kommandozeile schließt, musst du beim nächsten Öffnen erneut in den bin-Ordner wechseln.
+% \end{hinweis}
 % \subsubsection*{ki durch Chocolatey installieren}
 % \begin{itemize}
 %     \item Gebe in der Powershell den folgenden Befehl ein und drücke Enter\footnote{siehe auch \url{https://community.chocolatey.org/packages/ki}}:
@@ -103,7 +140,7 @@ \subsubsection{ki}
 %     \item Überprüfe die Installation (siehe Abschnitt \nameref{sec:check})
 % \end{itemize}
 % \begin{hinweis}
-%     Diese Installation funktioniert nur, solange sich deine Komandozeile im bin-Ordner befindet. Wenn du die Komandozeile schließt, musst du sie erneut öffnen und in den bin-Ordner wechseln.
+%     Diese Installation funktioniert nur, solange sich deine Kommandozeile im bin-Ordner befindet. Wenn du die Kommandozeile schließt, musst du sie erneut öffnen und in den bin-Ordner wechseln.
 % \end{hinweis}
 \section*{Mac OS}
 % Kaufe jetzt das Kotlin Starter Kit für nur 99,99€ im App Store und erhalte eine kostenlose Kotlin-Tasse im Wert von 9,99€ dazu! Nur solange der Vorrat reicht! (Nein, Spaß, aber wir haben leider keine Macs zum Testen.)
@@ -124,7 +161,7 @@ \subsection*{Homebrew Installieren}
 
 \subsection*{Automatische Installation durch Homebrew}
 \begin{itemize}
-    \item Gebe in der Komandozeile den folgenden Befehl ein und drücke Enter\footnote{Befehle generiert mit \url{https://formulae.brew.sh/formula/kotlin} und \url{https://formulae.brew.sh/formula/ki}}:
+    \item Gebe in der Kommandozeile den folgenden Befehl ein und drücke Enter\footnote{Befehle generiert mit \url{https://formulae.brew.sh/formula/kotlin} und \url{https://formulae.brew.sh/formula/ki}}:
         %\begin{noindent}
 \begin{commandshell}
 @\shellprefix{}@brew install kotlin
@@ -158,13 +195,13 @@ \subsection*{ki}
 \section*{Überprüfung der Installation}\label{sec:check}
 Um zu testen ob alles geklappt hat, öffne eine Kommandozeile und gebe den folgenden Befehl ein:
 \begin{commandshell}
-    @\shellprefix{}@kotlinc -version
+    @\shellprefix{}@kotlin -version
 \end{commandshell}
 
 Wenn alles geklappt hat, sollte die Ausgabe in etwa so aussehen (die Versionsnummern können abweichen):
 \begin{commandshell}[][]
-    @\shellprefix{}@kotlinc -version
-    info: kotlinc-jvm 1.9.10 (JRE 17.0.8.1+1)
+    @\shellprefix{}@kotlin -version
+    Kotlin version 1.9.10-release-459 (JRE 17.0.8.1+1)
 \end{commandshell}
 
 Ob \texttt{ki} funktioniert, kannst du mit dem folgenden Befehl testen:
@@ -178,5 +215,16 @@ \section*{Überprüfung der Installation}\label{sec:check}
     type :h for help
     [0] @\shellcursor@
 \end{commandshell}
+Falls folgende Ausgabe kommt, ist nicht mindestens Java 11 installiert und muss anhand der Anleitung oben nachgeholt werden:
+\nopagebreak
+\begin{commandshell}[][minted language=text]
+    Error: LinkageError occurred while loading main class org.jetbrains.kotlinx.ki.shell.KotlinShell
+    java.lang.UnsupportedClassVersionError: org/jetbrains/kotlinx/ki/shell/KotlinShell has been compiled by a more recent version of the Java Runtime (class file version 55.0), this version of the Java Runtime only recognizes class file versions up to 54.0
+\end{commandshell}
+Falls folgende Ausgabe kommt, ist Java gar nicht installiert und muss anhand der Anleitung oben nachgeholt werden:
+\nopagebreak
+\begin{commandshell}[][minted language=text]
+    The syntax of the command is incorrect.
+\end{commandshell}
 
 \end{document}
diff --git a/misc/linux_commands/TerminalGuide.tex b/misc/linux_commands/TerminalGuide.tex
@@ -152,20 +152,15 @@ \subsection{Kotlin}
 \end{defBox}
 \paragraph*{Compiler}\mbox{}
 
-Mit \textit{kotlinc} kann man kts-Skripte ausführen.
+Mit \textit{kotlin} kann man kts-Skripte ausführen.
 \begin{defBox}
     \fatsf{Achtung:} Die Dateiendung ist hierbei entscheidend.
 \end{defBox}
 
-\begin{commandshell}
-    @\shellprefix@kotlinc -script @\textit{\PYG{l+s}{<Datei.kts>}}@
-\end{commandshell}
-
-Auf Unix geht auch:
-
 \begin{commandshell}
     @\shellprefix@kotlin @\textit{\PYG{l+s}{<Datei.kts>}}@
 \end{commandshell}
+
 \clearpage
 \paragraph*{REPL}\mbox{}