Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added link to GitHub pages
  • Loading branch information
itsBelinda authored Aug 20, 2020
1 parent 0978a2f commit ab52450
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@ A demonstration of the application can be found on YouTube.
</a>
</p>

## Documentation

The Doxygen documentation is available on GitHub pages: https://itsbelinda.github.io/obp/

Alternatively, it can be built from the configuration file in the [doxygen](https://github.com/itsBelinda/obp/tree/master/doc/doxygen) folder.

# Installation (C++)
The following instructions concern the code located in the [C++ folder](https://github.com/itsBelinda/obp/tree/master/c%2B%2B).
Expand Down Expand Up @@ -54,7 +59,7 @@ Then install as usual:

## Building the Projcet
The project is set-up as a cmake project (details are defined in [CMakeList.txt](https://github.com/itsBelinda/obp/tree/master/c%2B%2B/CMakeLists.txt)).
Run `cmake .` from the console in the source foler ([c++](https://github.com/itsBelinda/obp/tree/master/c%2B%2B) to generate the Makefile and `make` to compile.
Run `cmake .` from the console in the source foler ([c++](https://github.com/itsBelinda/obp/tree/master/c%2B%2B)) to generate the Makefile and `make` to compile.
Run `ctest` to run the test.


Expand Down

0 comments on commit ab52450

Please sign in to comment.