From cf8875463c9fba76d529ac5b5090ba9d408aff52 Mon Sep 17 00:00:00 2001 From: Jakob Scheid Date: Mon, 27 Apr 2026 22:43:52 +0200 Subject: [PATCH] Add README --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index e69de29..9e7880c 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,22 @@ +# jcloud-docsgen + +A tool that generates Markdown documentation for software project source code. + +Currently, following source code languages are supported: +- Python + +## Installation + +You can install it using pip: + +```bash +pip install jcloud-docsgen --index-url https://repo.jcloud-services.ddns.net/simple/ --extra-index-url https://pypi.org/simple/ +``` + +## Reference + +API reference and generated documentation can be found in [docs/reference](docs/reference). + +## Notice + +This project is under active development. The documentation will be expanded over time. \ No newline at end of file