docs: add `package-info.java` and `readme.md`

For `API/CheerpJ`
This commit is contained in:
The-Lum 2023-11-15 13:53:30 +00:00
parent 91d46a866e
commit acb95b44ce
2 changed files with 23 additions and 0 deletions

View File

@ -0,0 +1,7 @@
/**
* Provides classes used to manage PlantUML with the
* <a href="https://labs.leaningtech.com/cheerpj3" target="_top">
* CheerpJ</a> API.
*
*/
package cheerpj;

View File

@ -0,0 +1,16 @@
# Directory Documentation for `cheerpj`
## Description
This package provides classes used to manage [CheerpJ](https://labs.leaningtech.com/cheerpj3) API.
## Reference
- [CheerpJ](https://labs.leaningtech.com/cheerpj3)
## Use by
- :octocat: [plantuml/plantuml-core](https://github.com/plantuml/plantuml-core)
- on [`/plantuml-core/src/main/java`](https://github.com/plantuml/plantuml-core/tree/main/plantuml-core/src/main/java)
- :octocat: [plantuml/plantuml.js](https://github.com/plantuml/plantuml.js)
## Demonstration
- [`plantuml-core/raw.html`](https://plantuml.github.io/plantuml-core/raw.html)
- [`plantuml.js`](https://plantuml.github.io/plantuml.js/)