Skip to content

Commit

Permalink
Update readme (#79)
Browse files Browse the repository at this point in the history
* Update readme

* Remove unused files

* Update doc badge

* Remove doc badge
  • Loading branch information
tobre1 authored May 13, 2024
1 parent 8f850b1 commit 487b39d
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ Releases are tagged on the master branch and available in the [releases section]

## Installing

> [!NOTE]
> For more detailed installation instructions and troubleshooting tips, please refer to the ViennaPS [documentation](https://viennatools.github.io/ViennaPS/inst/).
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. Notably, ViennaPS operates as a header-only library, eliminating the need for a formal installation process. Nonetheless, we advise following the outlined procedure to neatly organize and relocate all header files to a designated directory:

```bash
Expand Down

0 comments on commit 487b39d

Please sign in to comment.