From 618c775cf5a2273feb47cfe7bc4563255854175e Mon Sep 17 00:00:00 2001 From: Lorenzo Cogotti Date: Wed, 14 Dec 2022 12:41:04 +0100 Subject: [PATCH] [README] Add documentation walkthrough. --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 66fa3a7..5ce5010 100644 --- a/README.md +++ b/README.md @@ -98,7 +98,7 @@ These may be picked with the `CONFIG` variable. ### Installing using Makefiles -**lua-osx** Makefile supports your average `clean`, `install` and `uninstall` +**lua-osx** Makefile supports your average `clean`, `doc`, `install` and `uninstall` targets, thus you can install **lua-osx** system wide by running: ```sh # make install @@ -106,7 +106,20 @@ targets, thus you can install **lua-osx** system wide by running: ## Documentation -Currently in progress, stay tuned! +**lua-osx** uses [LDoc]() for documentation. + +You can generate documentation using `ldoc` directly, with the following command: +```sh +ldoc . +``` + +Or using the `doc` `Makefile` target: +```sh +make doc +``` + +Both methods generate a `doc` directory, open `doc/index.html` +with your favorite browser to read the API documentation. ## Similar Projects