Verified Commit 293c78de authored by Lars Bilke's avatar Lars Bilke

[web] Inline div has to be followed by blank line.

https://spec.commonmark.org/0.18/#example-108
parent 0ce0531b
......@@ -12,10 +12,13 @@ weight = 1031
## Install ninja
<div class='win'>
Download *ninja.zip* from the [latest GitHub release](https://github.com/ninja-build/ninja/releases/latest). Unzip it and make sure that the directory containing the `ninja.exe` is the `PATH`-environment variable!
</div>
<div class='linux'>
Install with your package manager:
```bash
......@@ -25,6 +28,7 @@ sudo apt-get install ninja-build
</div>
<div class='mac'>
Install via Homebrew:
```bash
......@@ -47,4 +51,5 @@ ninja
### <i class="far fa-exclamation-triangle"></i> Visual Studio remarks
When you configure with the Ninja generator you have to run CMake from the appropriate Visual Studio Command Prompt! From there you can both use `cmake` as well as `cmake-gui` which starts the GUI. In the GUI select the `Ninja` generator and leave the toggle `Use default native compilers` on.
</div>
......@@ -31,6 +31,7 @@ When you want to start over with a new configuration simply delete the build-dir
[See this]({{< ref "configuration-options" >}}) for a list of available options.
<div class='win'>
<div class='note'>
### <i class="far fa-exclamation-triangle"></i> Supported Visual Studio Generators
......@@ -38,6 +39,7 @@ When you want to start over with a new configuration simply delete the build-dir
- `Visual Studio 15 2017 Win64`
</div>
</div>
### Note: Installation of required libraries
......@@ -47,6 +49,7 @@ It is preferred to use the Conan package manager to install required third-party
Instead of using Conan you can optionally [install the required libraries manually]({{< ref "third-party-libraries.md" >}}) **before** running CMake.
<div class='win'>
<div class='note'>
#### <i class="far fa-exclamation-triangle"></i> Multi-configuration with Conan and Visual Studio
......@@ -65,7 +68,9 @@ cmake ../../ogs -G "Visual Studio 15 2017 Win64" -DCMAKE_BUILD_TYPE=Release
`..\..\ogs` represents the relative path to the source code (please adapt if you have a different directory layout).
Please also note that in Visual Studio you have to choose the correct configuration (i.e. when opening the solution-file in the release-folder you have to switch the Visual Studio configuration to **Release**)!
</div>
</div>
## Option: Configure from the command line
......@@ -104,10 +109,13 @@ Use [ConEmu](https://conemu.github.io) for a better terminal experience. It auto
## Option: Configure with a visual tool
<div class='win'>
CMake comes with a graphical tool called **cmake-gui**. You can find it in the **Windows Start Menu**. First you need to set the source and build directory. Then click **Configure**. Now choose the generator to be used (e.g. **Visual Studio 15 2017 Win64** for Visual Studio 2015 64-bit). Now choose your desired configuration options by toggling the corresponding checkboxes. Click **Configure** again. Click **Configure** often enough until the **Generate**-button becomes visible. Pressing **Generate** will finally generate the project files inside the chosen build directory.
</div>
<div class='linux'>
A more convenient way of running cmake on the command line is to use the `ccmake` tool. This is a shell tool but with some graphical user interface. To use it just run `ccmake` inside your build directory with the path to the source code (and optionally the generator you want to use) as parameter:
```bash
......@@ -117,8 +125,11 @@ ccmake ../ogs
First press <kbd>C</kbd> to **Configure**. You are now presented the available configuration options. You can navigate in the list with the cursor keys and toggle / alter options with <kbd>Enter</kbd>. You may also press <kbd>T</kbd> to toggle (previously hidden) advanced options. Press <kbd>C</kbd> again until the **Generate**-option becomes visible. Press <kbd>G</kbd> to generate the project files and exit `ccmake`.
There is also the tool `cmake-gui` available, please see the Win-Tab for a description.
</div>
<div class='mac'>
Please see the Linux instructions!
</div>
......@@ -107,7 +107,8 @@ The Homebrew package manager is needed for installing other libraries and packag
Git is a powerful and distributed version control system. OGS source code is hosted on [GitLab](https://gitlab.opengeosys.org/ogs/ogs). See the developer guide page on [Code Reviews]({{< ref "code-reviews" >}}) for more info on how OGS uses GitLab for collaborative development.
<div class='win'>
Download and install git from the [git homepage](http://git-scm.com/download/win). Use the default installer options but also enable `Enable symbolic links` under the *Configuring extra options* page.
**Download** and install git from the [git homepage](http://git-scm.com/download/win). Use the default installer options but also enable `Enable symbolic links` under the *Configuring extra options* page.
![Enable symbolic links option](../git-installer-win.png)
......@@ -129,6 +130,7 @@ git config --global http.proxy http://yourproxy.example.com
</div>
<div class='linux'>
Please check if Git is already installed:
```bash
......@@ -164,6 +166,7 @@ git config --global http.proxy http://yourproxy.example.com
</div>
<div class='mac'>
Install Git with Homebrew:
```bash
......@@ -212,6 +215,7 @@ sudo apt-get install python3 python3-pip
</div>
<div class='mac'>
Install Python 3 with Homebrew:
```bash
......@@ -229,12 +233,14 @@ brew install python
</div>
<div class='linux'>
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 CMake with Homebrew:
```bash
......
......@@ -46,6 +46,7 @@ See [the Benchmarks section](/docs/benchmarks/) for more information on the benc
OGS is a command line application and requires the path to a `.prj`-file as an argument.
<div class='win'>
To run it open a new command line shell (called *cmd.exe*). Now simply type `ogs` (if the executable is in your `PATH`-environment variable) or specify its full path (e.g.: `C:\Users\MyUserName\Downloads\ogs.exe`) and hit `ENTER`.
OGS prints out its usage instructions:
......@@ -72,6 +73,7 @@ ogs .\Path\to\BenchmarkName.prj
</div>
<div class='linux'>
To run it open a new command line shell (*Terminal*). Now simply type `ogs` (if the executable is in your `PATH`-environment variable) or specify its full path (e.g.: `./path/to/ogs`) and hit `ENTER`.
OGS prints out its usage instructions:
......@@ -98,5 +100,7 @@ ogs ./path/to/BenchmarkName.prj
</div>
<div class='mac'>
See Linux tab!
</div>
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment