added links to slides (work in progress)

Author: thomasWeise

README.md

@@ -2,47 +2,61 @@
 
 ## 1. Introduction
 
-**Download our book from <https://thomasweise.github.io/programmingWithPython/programmingWithPython.pdf>.**
+*"Programming with Python"* is both a book and a course held at [Hefei University](http://www.hfuu.edu.cn/english/) ([合肥大学](http://www.hfuu.edu.cn/)).
+We here provide all the resources of this course.
 
-**If you have any comments or suggestions regarding the book, or if you spotted an error or typo, please feel free to submit an [issue here](https://github.com/thomasWeise/programmingWithPython/issues).**
-Your feedback would help us to improve the book.
-
-This book tries to teach undergraduate and graduate students as well as high school students how to program with the Python programming language.
-It aims to strike a good balance between theory and practice, leaning more to the practice side.
+The goal of the course and book is to teach undergraduate and graduate students how to program with the Python programming language.
+The resources may also be suitable to high school students or whoever else may be interested in the topic.
+Our aim is to strike a good balance between theory and practice, leaning more to the practice side.
 In particular, we try to teach programming together with some software engineering concepts.
 It is the firm opinion of the author that these two cannot be separated.
 Teaching programming alone without introducing tools such as static code analysis, unit tests, and enforcing principles such as code style and proper commenting will create bad programmers.
 So we discuss these aspects while working our way through the principles of programming.
 
-This book is intended to be read on an electronic device.
-Please do not print it.
-Help preserving the environment.
 
-This book is work in progress.
-It will take years to be completed and I plan to keep improving and extending it for quite some time.
+## 2. Resources
+The website with up-to-date information about the course is <https://thomasweise.github.io/programmingWithPython>.
 
-This book is freely available.
-You can download its newest version from <https://thomasweise.github.io/programmingWithPython/>.
-This version may change since this book is, well, work in progress.
-You can freely share this.
-You can also copy text or figures, as long as you cite the book as the original source, e.g., by using the following BibTeX:
+### 2.1. The Book
+The book itself can be downloaded as pdf at <https://thomasweise.github.io/programmingWithPython/programmingWithPython.pdf>.
 
-<pre>@book{programmingWithPython,<br/>&nbsp;author&nbsp;=&nbsp;{<a href="http://iao.hfuu.edu.cn/5">Thomas&nbsp;Weise</a>},<br/>&nbsp;title&nbsp;=&nbsp;{Programming&nbsp;with&nbsp;Python},<br/>&nbsp;year&nbsp;=&nbsp;{2024},<br/>&nbsp;publisher&nbsp;=&nbsp;{<a href="http://iao.hfuu.edu.cn">Institute&nbsp;of&nbsp;Applied&nbsp;Optimization</a>,<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="http://www.hfuu.edu.cn/aibd">School&nbsp;of&nbsp;Artificial&nbsp;Intelligence&nbsp;and&nbsp;Big&nbsp;Data</a>,<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="http://www.hfuu.edu.cn/">Hefei&nbsp;University</a>},<br/>&nbsp;address&nbsp;=&nbsp;{Hefei,&nbsp;Anhui,&nbsp;China},<br/>&nbsp;url&nbsp;=&nbsp;{<a href="https://thomasweise.github.io/programmingWithPython">https://thomasweise.github.io/programmingWithPython</a>}<br/>}</pre>
+### 2.2. The Slides
+The slides for the course are available at <https://thomasweise.github.io/programmingWithPythonSlides> and also listed below.
+
+1. [Introduction](https://thomasweise.github.io/programmingWithPythonSlides/01_introduction.pdf)
+2. [Getting Started](https://thomasweise.github.io/programmingWithPythonSlides/02_getting_started.pdf)
 
-This book contains a lot of examples.
+### 2.3. The Example Python Programs 
+Our course offers a lot of examples.
 You can find all of them in the repository <https://github.com/thomasWeise/programmingWithPythonCode>.
-You can clone this repository and play with these example codes.
 
 
-## 2. License
+### 2.4. LaTeX Sources, Graphics, Bibliography, etc.
+Both the book and the slides are written in LaTeX.
+You can find their sources in <https://github.com/thomasWeise/programmingWithPython> and <https://github.com/thomasWeise/programmingWithPythonSlides>, respectively.
+You may use these files under the licensing terms provided below.
+
+
+## 3. License
+All the course material is freely available.
+You can download its newest version from <https://thomasweise.github.io/programmingWithPython>.
+This version may change since this course and book both are work in progress.
+You can freely share this.
+You can also copy text or figures under the license given below, as long as you cite the book as the original source, e.g., by using the following BibTeX:
+
+<pre>@book{programmingWithPython,<br/>&nbsp;author&nbsp;=&nbsp;{<a href="http://iao.hfuu.edu.cn/5">Thomas&nbsp;Weise</a>},<br/>&nbsp;title&nbsp;=&nbsp;{Programming&nbsp;with&nbsp;Python},<br/>&nbsp;year&nbsp;=&nbsp;{2024},<br/>&nbsp;publisher&nbsp;=&nbsp;{<a href="http://iao.hfuu.edu.cn">Institute&nbsp;of&nbsp;Applied&nbsp;Optimization</a>,<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="http://www.hfuu.edu.cn/aibd">School&nbsp;of&nbsp;Artificial&nbsp;Intelligence&nbsp;and&nbsp;Big&nbsp;Data</a>,<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="http://www.hfuu.edu.cn/">Hefei&nbsp;University</a>},<br/>&nbsp;address&nbsp;=&nbsp;{Hefei,&nbsp;Anhui,&nbsp;China},<br/>&nbsp;url&nbsp;=&nbsp;{<a href="https://thomasweise.github.io/programmingWithPython">https://thomasweise.github.io/programmingWithPython</a>}<br/>}</pre>
+
+**If you have any comments or suggestions regarding the book, or if you spotted an error or typo, please feel free to submit an [issue here](https://github.com/thomasWeise/programmingWithPython/issues).**
+Your feedback would help us to improve the book.
+
 This book is released under the Attribution-NonCommercial-ShareAlike 4.0 International license (CC&nbsp;BY&#8209;NC&#8209;SA&nbsp;4.0), see [http://creativecommons.org/licenses/by-nc-sa/4.0/](http://creativecommons.org/licenses/by-nc-sa/4.0/) for a summary.
 
 We statically include the [pdfsizeopt](https://github.com/pts/pdfsizeopt) tool in the [GitHub Repository](https://github.com/thomasWeise/programmingWithPython) of our book and use it during the book compiling and building process to compress the book pdf file.
 This tool is excluded from the license mentioned above.
 It is under the GNU GENERAL PUBLIC LICENSE Version 2, June 1991 and the copyright belongs to its authors.
 
 
-## 3. Contact
+## 4. Contact
 If you have any questions or suggestions, please contact
 Prof. Dr. [Thomas Weise](http://iao.hfuu.edu.cn/5) (汤卫思教授)
 at the Institute of Applied Optimization (应用优化研究所, [IAO](http://iao.hfuu.edu.cn))

styles/definitions.sty

@@ -5,10 +5,7 @@
 \theorembodyfont{\normalfont}%
 \newcommand{\definitionautorefname}{Definition}%%
 %
-%%% Best Practices
-%% The best practices suite offers the command \bestPractice that prints
-%% information  about a best practice in a framed box.
-%% The list of all best practices can be printed via \printBestPractices.
+%%% Definitions
 \newmdtheoremenv[%
 linewidth=2pt,%
 linecolor=definition-frame,%
@@ -22,6 +19,10 @@ nobreak=true%
 %
 \newcommand{\@bestPracticeautorefname}{Best Practice}%
 %
+%%% Best Practices
+%% The best practices suite offers the command \bestPractice that prints
+%% information  about a best practice in a framed box.
+%% The list of all best practices can be printed via \printBestPractices.
 \newmdtheoremenv[%
 linewidth=2pt,%
 linecolor=bestpractice-frame,%

text/front/preface/courseUrl.pdf

@@ -63,7 +63,10 @@ \chapter*{Preface}%
 \strut\vfill\strut%
 %
 \begin{center}%
-\includegraphics[width=7cm]{\currentDir/bookUrl}\\%
+\begin{tabular}{c@{~~~~~~~~~~~~}c}%
+\includegraphics[width=7cm]{\currentDir/bookUrl}&\includegraphics[width=7cm]{\currentDir/courseUrl}\\\relax%
+[\href{https://thomasweise.github.io/programmingWithPython/programmingWithPython.pdf}{book pdf}]&[\href{https://thomasweise.github.io/programmingWithPython}{course website}]\\%
+\end{tabular}\\[12pt]%
 \url{https://thomasweise.github.io/programmingWithPython/programmingWithPython.pdf}%
 \end{center}%
 %

text/front/preface/courseUrl.svg

@@ -190,5 +190,7 @@
 In these figures, I was using \ubuntu\ \linux.
 On \windows\ or other \linux\ variants, the process would have looked quite similar.%
 \endhsection%
+%
+\bestPractice{runningProgram}{The only proper way to run a \python\ application in a productive scenario is in the terminal, as shown in \cref{sec:terminalPython}.}%
 \endhsection%
 %

text/front/preface/preface.tex

@@ -128,7 +128,8 @@
 \bestPractice{noPycharmForProductive}{%
 \pycharm\ must \textbf{never} be used for running an application in a productive setting. %
 It is \emph{only} to be used as \pgls{IDE} for software development. %
-For actually executing programs, always use a \pglspl{virtualEnvironment} in the \pgls{terminal} as introduced in \cref{sec:pipAndVenv}.%
+For actually executing programs, always use a \pglspl{virtualEnvironment} in the \pgls{terminal} as introduced in \cref{sec:pipAndVenv}. %
+See also \cref{bp:runningProgram}.%
 }%
 %
 This holds also and especially for scenarios where we do use \python\ for scientific experiments.