Skip to content

Commit

Permalink
[DOCS] Readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
nots1dd committed Feb 3, 2025
1 parent 289aed4 commit 208e80a
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -377,8 +377,6 @@ The testing is done using GTest, read [TESTS.md](https;//github.com/nots1dd/inLi
There is a primitive Doxygen documention set up for the inLimbo project, that should explain a lot more about the thought process and idea behind every aspect of the codebase.
Man page is also under progress
To generate and view doxygen documentation locally:
```bash
Expand All @@ -394,6 +392,16 @@ It is much easier to use the script `make_docs.sh`
./make_docs.sh
```
### Manual Page
You can always refer to the man-page: (**Ensure that you have manpage-dev package installed**)
```bash
man inLimbo
```
It should provide with an in-depth documentation of everything you need.
Or you could just visit [inLimbo Website](https://nots1dd.github.io/inLimbo/)
## CREDITS
Expand Down

0 comments on commit 208e80a

Please sign in to comment.