generated from jCloud/repository-template
Add README
This commit is contained in:
@@ -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.
|
||||||
Reference in New Issue
Block a user