From 1c6cd1cf7f589dcfc5c373fd6569e77e666aa76e Mon Sep 17 00:00:00 2001 From: The-Lum <86879521+The-Lum@users.noreply.github.com> Date: Wed, 25 Jan 2023 19:42:56 +0000 Subject: [PATCH] Upd: Add some documentation - [x] Add EBNF on README - [x] Attemps to add some `README.md` on the src --- README.md | 1 + stdlib/README.md | 16 ++++++++++++++++ 2 files changed, 17 insertions(+) create mode 100644 stdlib/README.md diff --git a/README.md b/README.md index ad812c2eb..576869d6d 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,7 @@ PlantUML is a component that allows to quickly write: The following non-UML diagrams are also supported: * [JSON data](http://plantuml.com/json) * [YAML data](http://plantuml.com/yaml) + * [Extended Backus-Naur Form (EBNF) diagram](http://plantuml.com/ebnf) * [Network diagram (nwdiag)](http://plantuml.com/nwdiag) * [Wireframe graphical interface or UI mockups (salt)](http://plantuml.com/salt) * [Archimate diagram](http://plantuml.com/archimate-diagram) diff --git a/stdlib/README.md b/stdlib/README.md new file mode 100644 index 000000000..ac4bb1dd6 --- /dev/null +++ b/stdlib/README.md @@ -0,0 +1,16 @@ +# Standard Library (`stdlib`) of PlantUML + +This directory contains all the Standard Library (`stdlib`) files on a compressed format (`.repx`). + +### Source +For the source of the Standard Library (`stdlib`): + +- See this offficial dedicated source repository: + - https://github.com/plantuml/plantuml-stdlib +- See also this collaboratif repository _(Unofficial PlantUML stdlib)_: + - https://github.com/plantuml-stdlib + +### Format +For the compressed format (`.repx`), see this part of code: + - [src/net/sourceforge/plantuml/preproc/Stdlib.java](https://github.com/plantuml/plantuml/blob/master/src/net/sourceforge/plantuml/preproc/Stdlib.java) +