minor improvements to the text

Author: thomasWeise

notation/acronyms.sty

@@ -2,5 +2,6 @@
 %%% The acronyms.
 %%%
 %
-\newacronym{IDE}{IDE}{Integrated Development Environment, see also \gls{ide}}%
+\newacronym[description={Integrated Development Environment, see \gls{ide}}]{IDE}{IDE}{Integrated Development Environment}%
+\newacronym[description={Version Control Systems, see \gls{vcs}}]{VCS}{VCS}{Version Control Systems}%
 %

notation/terms.sty

@@ -2,12 +2,18 @@
 %% Access to Source Codes
 %%
 %
+\newglossaryentry{git}{%
+name={Git},
+description={%
+Git is a distributed \acrfull{VCS} which allows multiple users to work on the same code while preserving the history of the code changes.%
+}%
+}%
 %
 \newglossaryentry{ide}{%
 name={Integrated Development Environment},
 sort={Integrated Development Environment},
 description={%
-A \gls{IDE} is a program that allows the user do multiple different activities required for software development in one single system. %
+An \acrfull{IDE} is a program that allows the user do multiple different activities required for software development in one single system. %
 It often offers functionality such as editing source code, debugging, testing, or interaction with a distributed version control system. %
 For this course, we recommend using \pycharm.%
 }%
@@ -36,3 +42,13 @@ Under \ubuntu\ \linux, \ubuntuTerminal\ opens a terminal.%
 }%
 }%
 %
+\newglossaryentry{vcs}{%
+name={Version Control System},
+plural={Version Control Systems},
+description={%
+A \acrfull{VCS} is a software which allows you to manage and preserve the historical development of your program code. %
+A distributed \gls{VCS} allows multiple users to work on the same code and upload their changes to the server, which then preserves the change history.
+The most popular distributed \gls{VCS} is \gls{git}.%
+}%
+}%
+%

text/main/basics/gettingStarted/gettingStarted.tex

@@ -1,6 +1,20 @@
 \hsection{Getting Started}%
 %
 This course should be a practical course, so we should get started with practical things right away.
+In order to do practical things, we need to have all the necessary software on our computer.
+What software is necessary to do \python\ programming?
+Well, first of all, \python.
+If \python\ is not yet installed on your machine, then we briefly outline in \cref{sec:installingPython} how you can install it.
+
+Now with the programming language \python\ alone, you cannot really do much -- in a convenient way, at least.
+You need a nice editor in which you can write the programs.
+Actually, you want an editor where you can not just write programs.
+You want an editor  where you can also directly execute and test your programs.
+In software development, you often work with a \gls{VCS} like \gls{git}.
+You want to do that convenient from your editor.
+Such an editor, which integrates many of the common tasks that occur during programming, is called an \gls{IDE}.
+In our course, you will work with the \pycharm\ \gls{IDE}.
+If you do not yet have \pycharm\ installed, in \cref{sec:installingPyCharm} we give a brief summary on how you can install it.%
 %
 \hinput{installingPython}{installingPython}%
 \hinput{installingPyCharm}{installingPyCharm}%

text/main/basics/gettingStarted/installingPyCharm/installingPyCharm.tex

@@ -1,4 +1,5 @@
 \hsection{Installing PyCharm}%
+\label{sec:installingPyCharm}%
 %
 Just having a programming language and the corresponding interpreter on your system is not enough.
 Are you going to write programs in a simple text editor like a caveperson?

text/main/basics/gettingStarted/installingPyCharm/installingPyCharmUbuntu/installingPyCharmUbuntu.tex

@@ -61,14 +61,16 @@
 \label{fig:installingPyCharmUbuntu}%
 \end{figure}%
 %
+\begin{sloppypar}%
 Installing \pycharm\ under \ubuntu\ \linux\ is very easy, as illustrated in \cref{fig:installingPyCharmUbuntu}.
 First, you open a \gls{terminal} by pressing \ubuntuTerminal.
 Then, enter the command \bashil{sudo snap install pycharm-community --classic} and hit return~(\cref{fig:installingPyCharmUbuntu01snapInstall}).
 This installs the \pycharm\ software package and the necessary super user privileges are obtained via the pre-pended \gls{sudo}, which will ask us to enter the root password, as sketched in \cref{fig:installingPyCharmUbuntu02sudo}.
 Then, the installation process basically runs automatically.
 Once it has completed (see \cref{fig:installingPyCharmUbuntu05snapInstallFinished}), you can press the \keys{\OSwin} key and type \bashil{pycharm} in the launcher window to find \pycharm~(\cref{fig:installingPyCharmUbuntu06launcher}).
-A double-click will open \pycharm.
-
+A double-click will open \pycharm.%
+\end{sloppypar}%
+%
 In the installation instructions for \windows, now a user agreement~(\cref{fig:installingPyCharmWindows16running}) and data upload statement~(\cref{fig:installingPyCharmWindows17running}) need to be performed.
 Since I already had \pycharm\ installed previously and probably already agreed/disagreed to them, respectively, these windows did not open in my current installation and I could not take screenshots of them.
 If they open, then you can probably treat them exactly as suggested in the \windows\ installation instructions \cref{sec:installingPyCharmWindows}.

text/main/basics/gettingStarted/installingPython/installingPython.tex

@@ -1,4 +1,5 @@
 \hsection{Installing Python}%
+\label{sec:installingPython}%
 In order to learn and use \python, we first need to install it.
 There are two major versions of \python\ out there: \python~\softwareStyle{2} and \python~\softwareStyle{3}.
 Our course focuses entirely on \python~\softwareStyle{3}.