Apply suggestions from code review

Co-authored-by: Bernhard Manfred Gruber <[email protected]>

.gitignore

@@ -25,3 +25,5 @@
 # igonre build and install folder
 /build*
 /install*
+
+.vscode

README.md

@@ -9,9 +9,9 @@
 
 ![vikunja](docs/source/logo/vikunja_logo.png)
 
-Vikunja is a performance portable algorithms library defines functions for a variety of purposes that operate on ranges of elements. It supports the execution on multi core CPUs and various GPUs.
+Vikunja is a performance portable algorithms library that defines functions operating on ranges of elements for a variety of purposes . It supports the execution on multi core CPUs and various GPUs.
 
-Vikunja uses [alpaka](https://github.com/alpaka-group/alpaka) to implement platform independent primitives such like `reduce` or `transform`. 
+Vikunja uses [alpaka](https://github.com/alpaka-group/alpaka) to implement platform independent primitives such as `reduce` or `transform`. 
 
 # Installation
 ## Install Alpaka
@@ -20,7 +20,8 @@ Alpaka requires a [boost installation](https://github.com/alpaka-group/alpaka#de
 
 ```bash
 git clone --depth 1 --branch 0.8.0 https://github.com/alpaka-group/alpaka.git
-cd vikunja/build
+mkdir alpaka/build
+cd alpaka/build
 cmake ..
 cmake --install .
 ```

docs/source/basic/installation.rst

@@ -3,12 +3,24 @@ Installation
 
 Vikunja builds and installs itself using `CMake <https://cmake.org/>`_. Before you can install and use vikunja, you have to install the only dependency `alpaka <https://github.com/alpaka-group/alpaka>`_. Vikunja supports alpaka from version 0.6 until 0.8. It is recommend to use the latest alpaka version. Alpaka itself has also a single dependency, boost. Read the `alpaka documentation <https://github.com/alpaka-group/alpaka#dependencies>`_ to determine the supported boost version.
 
+**Install alpaka:**
+
+.. code-block:: bash
+
+   # alpaka requires a boost installation, see alpaka documentation
+   git clone --depth 1 --branch 0.8.0 https://github.com/alpaka-group/alpaka.git
+   mkdir alpaka/build
+   cd alpaka/build
+   cmake ..
+   cmake --install .
+
+**Install vikunja:**
+
 .. code-block:: bash
 
-  # assumed alpaka is installed via `cmake --install .` on a location, where cmake can find it
-  # git clone https://github.com/alpaka-group/vikunja.git
-  cd vikunja
-  mkdir build && cd build
+  git clone https://github.com/alpaka-group/vikunja.git
+  mkdir vikunja/build 
+  cd vikunja/build  
   cmake ..
   cmake --build .
   cmake --install .

docs/source/index.rst

@@ -12,7 +12,9 @@
      :alt: vikunja logo
 
 
-Vikunja is a performance portable algorithms library defines functions for a variety of purposes that operate on ranges of elements. It supports the execution on multi core CPUs and various GPUs.
+Vikunja is a performance portable algorithms library that defines functions operating on ranges of elements for a variety of purposes . It supports the execution on multi core CPUs and various GPUs.
+
+Vikunja uses `alpaka <https://github.com/alpaka-group/alpaka>`_ to implement platform independent primitives such as ``reduce`` or ``transform``.
 
 
 vikunja - How to Read This Document