Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
koaning authored Jan 24, 2022
1 parent 8a4fa88 commit c762a7e
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,3 +197,19 @@ Alternatively you may also run this via the `Makefile`:
```
make install
```

## Documentation

If you want to build the documentation locally you can do so via;

```
mkdocs serve
```

If you want to deplot the docs to GitHub you can run;

```
mkdocs gh-deploy
```

This will deploy a new version to the `docs` branch, which is picked up by GitHub pages.

0 comments on commit c762a7e

Please sign in to comment.