Commit 107c821b authored by Maximilian Dolling's avatar Maximilian Dolling

correctly lnked the docs in the readme

parent 0b411557
......@@ -41,24 +41,15 @@ The software you want to run the services on **must** be a [git](https://git-scm
---
## Usage
Some of the services require a config file.
To see which, take a look at the [service description](docs/pages/services.md)
Running the services via Gitlab CI/CD is the recommended solution.
It keeps the report up to date, every time the project is changed.
You can read more about how it is set up [here](docs/pages/usage_ci.md).
Running it on you local machine is easier to set up.
Therefore it must be triggered manually before every release.
You can read more about how it is set up [here](docs/pages/usage_local.md).
---
## Service Description
You can find a detailed description of all implemented services [here](docs/pages/services.md).
## Documentation
You can find the documentation [here](http://software.gitext.gfz-potsdam.de/services/fair/software-quality-assurance/).
In case you received a local copy of the project, you can build and view the documentation like this:
```shell script
cd docs
make html
$BROWSER build/html/index.html
```
---
......
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