From 208e80a34c939158c5f8de7be0d3e2e61125d54a Mon Sep 17 00:00:00 2001 From: nots1dd Date: Mon, 3 Feb 2025 20:15:14 +0530 Subject: [PATCH] [DOCS] Readme update --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index dda89e8..339b794 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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