Skip to content

Commit

Permalink
Minor update of README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
FilipovicLado authored May 9, 2023
1 parent d18ab3b commit 1daad71
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Since this is a header only project, it does not require any installation.
However, we recommend the following procedure in order to set up all dependencies correctly:

```bash
git clone github.com/ViennaTools/ViennaLS.git
git clone https://github.com/ViennaTools/ViennaLS.git
cd ViennaLS
mkdir build && cd build
cmake .. -DCMAKE_INSTALL_PREFIX=/path/to/your/custom/install/
Expand All @@ -64,7 +64,7 @@ This will install the necessary headers and CMake files to the specified path. I

In order to install ViennaLS without VTK, run:
```bash
git clone github.com/ViennaTools/ViennaLS.git
git clone https://github.com/ViennaTools/ViennaLS.git
cd ViennaLS
mkdir build && cd build
cmake .. -DCMAKE_INSTALL_PREFIX=/path/to/your/custom/install/ -DVIENNALS_USE_VTK=OFF
Expand All @@ -77,7 +77,7 @@ make install
The CMake configuration automatically checks if the dependencies are installed. If CMake is unable to find them, the dependencies will be built from source with the _buildDependencies_ target.

```bash
git clone github.com/ViennaTools/ViennaLS.git
git clone https://github.com/ViennaTools/ViennaLS.git
cd ViennaLS
mkdir build && cd build
cmake .. -DCMAKE_INSTALL_PREFIX=/path/to/your/custom/install/
Expand All @@ -93,7 +93,7 @@ If one wants to use a specific installation of one or more of the dependencies,
The Python package can be built and installed using the `pip` command:

```bash
git clone github.com/ViennaTools/ViennaLS.git
git clone https://github.com/ViennaTools/ViennaLS.git
cd ViennaLS
pip install --user .
```
Expand All @@ -116,7 +116,7 @@ import viennals3d as vls
If you just want to install all dependencies before doing anything else, run:

```bash
git clone github.com/ViennaTools/ViennaLS.git
git clone https://github.com/ViennaTools/ViennaLS.git
cd ViennaLS
mkdir build && cd build
cmake .. -DCMAKE_INSTALL_PREFIX=/path/to/your/custom/install/
Expand All @@ -134,7 +134,7 @@ ViennaLS uses CTest to run its tests.
In order to check whether ViennaLS runs without issues on your system, you can run:

```bash
git clone github.com/ViennaTools/ViennaLS.git
git clone https://github.com/ViennaTools/ViennaLS.git
cd ViennaLS
mkdir build && cd build
cmake .. -DVIENNALS_BUILD_TESTS=ON
Expand All @@ -148,7 +148,7 @@ The examples can be built using CMake:

```bash
cmake .. -DVIENNALS_BUILD_EXAMPLES=ON
make
make buildExamples
```

## Integration in CMake projects
Expand Down

0 comments on commit 1daad71

Please sign in to comment.