diff --git a/web/content/docs/devguide/development-workflows/setup-fork.md b/web/content/docs/devguide/development-workflows/setup-fork.md index 48fc6361de8ccf75e8f3527a524891926ebe7dae..74e93c901f886c1f4ec7b0f85e21dc27254b2f2c 100644 --- a/web/content/docs/devguide/development-workflows/setup-fork.md +++ b/web/content/docs/devguide/development-workflows/setup-fork.md @@ -163,6 +163,19 @@ git rebase ufz/master feature-name This can potentially lead to conflicts, which have to be resolved. +<div class='note'> + +You may want to streamline the updating workflow a bit using the [`git pull --rebase --autostash`](https://cscheng.info/2017/01/26/git-tip-autostash-with-git-pull-rebase.html)-functionality. Enable it with: + +```bash +git config pull.rebase true +git config rebase.autoStash true +``` + +Then simply use `git pull upstream master`. + +</div> + ---- Now after you implemented the feature and committed your work you can push the new commits to the `feature-name`-branch on your GitLab fork: diff --git a/web/content/docs/devguide/getting-started/prerequisites.md b/web/content/docs/devguide/getting-started/prerequisites.md index 13db19798fc8ba7de6904ddd553ba82d559f9946..971ad96e5c3a71f594049ee69ece0cf916cbd539 100644 --- a/web/content/docs/devguide/getting-started/prerequisites.md +++ b/web/content/docs/devguide/getting-started/prerequisites.md @@ -176,11 +176,7 @@ git config --global http.proxy http://yourproxy.example.com <div class='mac'> -Install Git with Homebrew: - -```bash -brew install git -``` +Git is already installed. Let Git know who you are: @@ -199,79 +195,94 @@ git config --global http.proxy http://yourproxy.example.com </div> -## Step: Install Python 3 +## Step: Install CMake <div class='win'> -- [Download the Python 3 installer](https://www.python.org/ftp/python/3.9.1/python-3.9.1-amd64.exe) -- Install with the following options - - Check *Add Python 3.X to PATH* - - *Customize installation* - - Make sure to have `pip` enabled (you may uncheck *Documentation*, *tcl/tk*, *Python test suite*) - - Check *Add Python to environment variables*! - +- Download the installer, at the [CMake download page](http://www.cmake.org/cmake/resources/software.html) choose the **Windows (Win32 Installer)**. +- Execute the installer, please check the **Add CMake to the system path for all users**-option </div> <div class='linux'> -Install Python 3 and pip: - -```bash -sudo apt-get install python3 python3-pip -``` +Install CMake via Kitware's APT Repository by [following their instructions](https://apt.kitware.com/). +For other linux distributions you want to use your distributions package manager, [pip](https://pypi.org/project/cmake/) or [snap](https://snapcraft.io/cmake). </div> <div class='mac'> -Install Python 3 with Homebrew: +Install CMake with Homebrew: ```bash -brew install python +brew install cmake ``` </div> -## Step: Install CMake + +## Optional: Install Ninja + +We recommend [`ninja`](https://ninja-build.org) as a cross-platform build tool (`make`-replacement). <div class='win'> -- Download the installer, at the [CMake download page](http://www.cmake.org/cmake/resources/software.html) choose the **Windows (Win32 Installer)**. -- Execute the installer, please check the **Add CMake to the system path for all users**-option +Download the [binary from GitHub](https://github.com/ninja-build/ninja/releases) and put the extracted `ninja.exe` in the `PATH`. + </div> <div class='linux'> -Install CMake via Kitware's APT Repository by [following their instructions](https://apt.kitware.com/). +```bash +sudo apt-get install ninja-build +``` -For other linux distributions you want to use your distributions package manager, [pip](https://pypi.org/project/cmake/) or [snap](https://snapcraft.io/cmake). </div> <div class='mac'> -Install CMake with Homebrew: +Install Ninja with Homebrew: ```bash -brew install cmake +brew install ninja ``` </div> -## Optional: Install Ninja +## Optional: Install Python 3 -We recommend [`ninja`](https://ninja-build.org) as a cross-platform build tool (`make`-replacement). +<div class='win'> + +- [Download the Python 3 installer](https://www.python.org/ftp/python/3.9.1/python-3.9.1-amd64.exe) +- Install with the following options + - Check *Add Python 3.X to PATH* + - *Customize installation* + - Make sure to have `pip` enabled (you may uncheck *Documentation*, *tcl/tk*, *Python test suite*) + - Check *Add Python to environment variables*! + +</div> + +<div class='linux'> -Install Ninja with Python's pip: +Install Python 3 and pip: ```bash -pip3 install --user ninja +sudo apt-get install python3 python3-pip ``` -Make sure that `ninja` is in the path afterwards. See Conan install instructions above. +</div> +<div class='mac'> -## Optional: Install Qt for the Data Explorer +Install Python 3 with Homebrew: + +```bash +brew install python +``` + +</div> +## Optional: Install Qt for the Data Explorer Use [Another Qt installer(aqt)](https://github.com/miurahr/aqtinstall) for installing the Qt binaries to some path on your machine: