Make the link between the app and GitHub

.gitignore

@@ -0,0 +1 @@
+CMakeLists.txt.user

README.md

@@ -1,55 +1,50 @@
-## enroute flight navigation
-
-**enroute** is a mobile flight navigation app for Android and other devices. The app is free, open source and 100% non-commercial. We do not collect user data.
-
-**enroute** is a project of [Akaflieg Freiburg](https://akaflieg-freiburg.de), a flight club based in Freiburg, Germany.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+# enroute flight navigation
 
+**enroute** is a mobile flight navigation app for Android and other devices. The app is free, open source and 100% non-commercial. We do not collect user data. **enroute** is a project of [Akaflieg Freiburg](https://akaflieg-freiburg.de), a flight club based in Freiburg, Germany.
 
+## 1. Compilation
 
+**enroute** is a fairly large, but fairly standard Qt application that can be build on a standard Linux system. The build relies on **cmake**. The author uses Fedora Linux. Builds on Windows or MacOS hosts has never been attempted.
 
+The CMake scripts download substantial amounts of data during the build process.
 
+* Google's Material Design Icon set
 
+* Google's Roboto Fonts
 
+* Nitroshare's QHTTPEngine
 
+* For Android only: precompiled version of the openSSL libraries for various architectures.
 
+### 1.1 Building a desktop app
 
+On a standard Linux system, the following commands will build a desktop version of the app. The commands produce a single binary at ./src/enroute that links to Qt dynamically, but contains all the data required to run.
 
+```shell
+# Create build directory
+mkdir build
+cd build
 
+# Configure
+cmake <path to source directory>
 
+# Build
+make -j5
 
+# Enjoy
+./src/enroute
+```
 
+### 1.2 Building an Android app
 
+The author uses Qt Creator to build Android apps.
 
+### 1.3 Dependencies
 
+* **Qt development libraries**, version ≥ 5.12 for the desktop app and version ≥ 5.12 for the Android app.
 
+* **CMake**, version ≥ 3.13 for the desktop app and version ≥ 3.15 for the Android app.
 
+* Command line utilities: **curl**, **git**, **tar** (used to download data at configuration stage), **Doxygen**, **dot** (to build documentation,) **inkscape** (used to generate PNG versions of icons from SVG sources) and **python3** (used to compile lists of files during the configuration stage)
 
 

docs/_config.yml

@@ -65,9 +65,9 @@ plugins:
 footer:
   links:
     - label: "Privacy Policies"
-      url: privacy
+      url: /privacy
     - label: "Contact"
-      url: contact
+      url: /contact
     - label: "GitHub"
       icon: "fab fa-fw fa-github"
       url: "https://github.com/Akaflieg-Freiburg/enroute"

docs/_pages/download.markdown

@@ -10,13 +10,9 @@ permalink: /download/
 
 ### Mobile App for Android devices
 
-**enroute** is available for free download on the Google Play Store.
+**enroute** is available for free download at Google Play.
 
 
-### Desktop App for Linux Computers
-
-Linux users who want to use **enroute** on their desktop machines find a ready-to-use package on [flathub.org](https://flathub.org/home).  **enroute** might also be available through your distribution's software management tool.
-
 ### Source code
 
 Developers who are interested in compiling **enroute** themselves find all relevant sources on [GitHub](https://github.com/Akaflieg-Freiburg/enroute).
@@ -26,5 +22,5 @@ Developers who are interested in compiling **enroute** themselves find all relev
 
 **enroute** can be ported without much difficulty to Apple iOS devices, such as iPhones and iPads.  We are currently looking for volunteers who help with the port and maintain **enroute**'s presence in the Apple App Store. [Contact us](mailto:stefan.kebekus@gmail.com) if you would like to help!
 
-**enroute** cab be ported without much difficulty to Windows and MacOS desktop machines. We are currently looking for volunteers. [Contact us](mailto:stefan.kebekus@gmail.com) if you would like to help!
+**enroute** cab be ported without much difficulty to Linux, Windows and MacOS desktop machines. We are currently looking for volunteers. [Contact us](mailto:stefan.kebekus@gmail.com) if you would like to help!
 

docs/_pages/participate.markdown

@@ -7,12 +7,12 @@ toc: true
 
 ## Report bugs and errors
 
-We aim to provide very high-quality software. Fixing errors is therefore always our first priority. We are grateful for every report that we get. Please **report errors** by <a href="mailto:stefan.kebekus@gmail.com">contacting the author</a> directly.
+We aim to provide very high-quality software. Fixing errors is therefore always our first priority. We are grateful for every report that we get. Please **report errors** through the [GitHub issue tracker](https://github.com/Akaflieg-Freiburg/enroute/issues) (this might require opening an account with GitHub).  If you find this difficult, then please <a href="mailto:stefan.kebekus@gmail.com">contacting the author</a> directly.
 
 
 ## Suggest features and improvements
 
-Suggest improvements by <a href="mailto:stefan.kebekus@gmail.com">contacting the author directly.  We ask for your understanding that not all suggestions can be implemented immediately.
+We have great plans for **enroute**. Please check our [project list at GitHub](https://github.com/Akaflieg-Freiburg/enroute/projects).  Please **make further suggestions** through the [GitHub issue tracker](https://github.com/Akaflieg-Freiburg/enroute/issues) (this might require opening an account with GitHub).  If you find this difficult, then please <a href="mailto:stefan.kebekus@gmail.com">contacting the author</a> directly.  We ask for your understanding that not all your suggestions can be implemented immediately.
 
 
 ## Join the project

src/text/info_enroute.html.in

@@ -10,6 +10,8 @@
   <li>100% Open Source, written without commercial interest</li>
 </ul>
 
+Check <a href="https://akaflieg-freiburg.github.io/enroute/">the <strong>enroute</strong> web site</a> for more information.
+
 
 <h3>Acknowledgements</h3>
 

src/text/participate.html.in

@@ -1,38 +1,17 @@
 <h3>Report bugs and errors</h3>
 
-<p>We aim to provide very high-quality software. Fixing errors is therefore
-  always our first priority. We are grateful for every report that we get. Please <strong>report errors</strong>
-    by <a href="mailto:stefan.kebekus@gmail.com">contacting the author</a>
-    directly.</p>
+<p>We aim to provide very high-quality software. Fixing errors is therefore always our first priority. We are grateful for every report that we get. Please report errors through the <a href="https://github.com/Akaflieg-Freiburg/enroute/issues">GitHub issue tracker</a> (this might require opening an account with GitHub).  If you find this difficult, then please <a href="mailto:stefan.kebekus@gmail.com">contacting the author</a> directly.</p>
 
 
 <h3>Suggest features and improvements</h3>
 
-<p>Suggest improvements
-    by <a href="mailto:stefan.kebekus@gmail.com">contacting the author
-    directly</a>.  We ask for your understanding that not all suggestions can be
-    implemented immediately.</p>
+<p>We have great plans for <strong>enroute</strong>, check our <a href="https://github.com/Akaflieg-Freiburg/enroute/projects">project list at GitHub</a> to see what's coming.  Please make further suggestions through the <a href="https://github.com/Akaflieg-Freiburg/enroute/issues">GitHub issue tracker</a> (this might require opening an account with GitHub).  If you find this difficult, then please <a href="mailto:stefan.kebekus@gmail.com">contacting the author</a> directly.  We ask for your understanding that not all your suggestions can be implemented immediately.</p>
 
 
 <h3>Join the project</h3>
 
-<p>
-  If you would like to <strong>translate Enroute to your native
-    language</strong>, we would like
-    to <a href="mailto:stefan.kebekus@gmail.com">hear from you</a>. Programming
-    experience is not necessary, but good computer skills are required.
-</p>
-
-<p>
-  This app should run fine on <strong>Apple devices</strong>. If you would like
-  to port the app to iOS and if you have development experience with C++/Qt
-  programming and with Apple systems,
-  like <a href="mailto:stefan.kebekus@gmail.com">get in touch with us</a> today.
-</p>
-
-<p>
-  If you are fluent in C++ and if you would like to <strong>help with the
-    programming</strong>, <a href="mailto:stefan.kebekus@gmail.com">let us
-    know</a>.
-</p>
+<p>If you would like to <strong>translate Enroute to your native language</strong>, we would like to <a href="mailto:stefan.kebekus@gmail.com">hear from you</a>. Programming experience is not necessary, but good computer skills are required.</p>
 
+<p>This app should run fine on <strong>Apple devices</strong>. If you would like to port the app to iOS and if you have development experience with C++/Qt programming and with Apple systems, like <a href="mailto:stefan.kebekus@gmail.com">get in touch with us</a> today.</p>
+
+<p>If you are fluent in C++ and if you would like to <strong>help with the programming</strong>, <a href="mailto:stefan.kebekus@gmail.com">let us know</a>.</p>