From 28cc4638d6b178db1c4953b3dda40c0bcdac7b4f Mon Sep 17 00:00:00 2001
From: The-Lum <86879521+The-Lum@users.noreply.github.com>
Date: Tue, 17 Oct 2023 10:16:34 +0000
Subject: [PATCH] docs: add `package-info.java` and `readme.md` (for `abel` to
 `command`)

---
 .../plantuml/abel/package-info.java           |  6 +++++
 src/net/sourceforge/plantuml/abel/readme.md   | 14 ++++++++++
 .../plantuml/acearth/package-info.java        |  8 ++++++
 .../sourceforge/plantuml/acearth/readme.md    | 20 ++++++++++++++
 .../plantuml/ant/package-info.java            |  7 +++++
 src/net/sourceforge/plantuml/ant/readme.md    |  6 +++--
 .../plantuml/argon2/package-info.java         | 26 +++++++++++++++++++
 src/net/sourceforge/plantuml/argon2/readme.md | 22 ++++++++++++++++
 .../plantuml/asciiart/package-info.java       |  7 +++++
 .../sourceforge/plantuml/asciiart/readme.md   | 11 ++++++++
 .../plantuml/board/package-info.java          |  7 +++++
 src/net/sourceforge/plantuml/board/readme.md  | 11 ++++++++
 .../plantuml/bpm/package-info.java            |  7 +++++
 src/net/sourceforge/plantuml/bpm/readme.md    | 16 ++++++++++++
 .../plantuml/braille/package-info.java        |  7 +++++
 .../sourceforge/plantuml/braille/readme.md    | 11 ++++++++
 .../plantuml/brotli/package-info.java         | 15 +++++++++++
 src/net/sourceforge/plantuml/brotli/readme.md | 18 +++++++++++++
 .../plantuml/classdiagram/package-info.java   |  7 +++++
 .../plantuml/classdiagram/readme.md           | 14 ++++++++++
 .../plantuml/code/package-info.java           |  9 +++++++
 src/net/sourceforge/plantuml/code/readme.md   | 19 ++++++++++++++
 .../plantuml/command/package-info.java        |  7 +++++
 .../sourceforge/plantuml/command/readme.md    | 13 ++++++++++
 .../plantuml/ebnf/package-info.java           |  7 +++++
 src/net/sourceforge/plantuml/ebnf/readme.md   | 15 +++++++++++
 .../plantuml/filesdiagram/package-info.java   |  7 +++++
 .../plantuml/filesdiagram/readme.md           | 15 +++++++++++
 28 files changed, 330 insertions(+), 2 deletions(-)
 create mode 100644 src/net/sourceforge/plantuml/abel/package-info.java
 create mode 100644 src/net/sourceforge/plantuml/abel/readme.md
 create mode 100644 src/net/sourceforge/plantuml/acearth/package-info.java
 create mode 100644 src/net/sourceforge/plantuml/acearth/readme.md
 create mode 100644 src/net/sourceforge/plantuml/ant/package-info.java
 create mode 100644 src/net/sourceforge/plantuml/argon2/package-info.java
 create mode 100644 src/net/sourceforge/plantuml/argon2/readme.md
 create mode 100644 src/net/sourceforge/plantuml/asciiart/package-info.java
 create mode 100644 src/net/sourceforge/plantuml/asciiart/readme.md
 create mode 100644 src/net/sourceforge/plantuml/board/package-info.java
 create mode 100644 src/net/sourceforge/plantuml/board/readme.md
 create mode 100644 src/net/sourceforge/plantuml/bpm/package-info.java
 create mode 100644 src/net/sourceforge/plantuml/bpm/readme.md
 create mode 100644 src/net/sourceforge/plantuml/braille/package-info.java
 create mode 100644 src/net/sourceforge/plantuml/braille/readme.md
 create mode 100644 src/net/sourceforge/plantuml/brotli/package-info.java
 create mode 100644 src/net/sourceforge/plantuml/brotli/readme.md
 create mode 100644 src/net/sourceforge/plantuml/classdiagram/package-info.java
 create mode 100644 src/net/sourceforge/plantuml/classdiagram/readme.md
 create mode 100644 src/net/sourceforge/plantuml/code/package-info.java
 create mode 100644 src/net/sourceforge/plantuml/code/readme.md
 create mode 100644 src/net/sourceforge/plantuml/command/package-info.java
 create mode 100644 src/net/sourceforge/plantuml/command/readme.md
 create mode 100644 src/net/sourceforge/plantuml/ebnf/package-info.java
 create mode 100644 src/net/sourceforge/plantuml/ebnf/readme.md
 create mode 100644 src/net/sourceforge/plantuml/filesdiagram/package-info.java
 create mode 100644 src/net/sourceforge/plantuml/filesdiagram/readme.md

diff --git a/src/net/sourceforge/plantuml/abel/package-info.java b/src/net/sourceforge/plantuml/abel/package-info.java
new file mode 100644
index 000000000..a22acf5cf
--- /dev/null
+++ b/src/net/sourceforge/plantuml/abel/package-info.java
@@ -0,0 +1,6 @@
+/**
+ * Provides classes used to manage {@link Entity}.
+ *
+ * @see {@link net.sourceforge.plantuml.plasma} 
+ */
+package net.sourceforge.plantuml.abel;
diff --git a/src/net/sourceforge/plantuml/abel/readme.md b/src/net/sourceforge/plantuml/abel/readme.md
new file mode 100644
index 000000000..c3e87d7c9
--- /dev/null
+++ b/src/net/sourceforge/plantuml/abel/readme.md
@@ -0,0 +1,14 @@
+# Directory Documentation for `abel`
+
+## Description
+This package provides classes used to manage [`Entity`](./Entity.java).
+
+## Link
+
+## Reference
+
+## Credit
+
+## Misc.
+- [Abel _(on Wikipedia)_](https://en.wikipedia.org/wiki/Abel_(disambiguation))
+- [Niels Henrik Abel](https://en.wikipedia.org/wiki/Niels_Henrik_Abel)
diff --git a/src/net/sourceforge/plantuml/acearth/package-info.java b/src/net/sourceforge/plantuml/acearth/package-info.java
new file mode 100644
index 000000000..f3af0dc2a
--- /dev/null
+++ b/src/net/sourceforge/plantuml/acearth/package-info.java
@@ -0,0 +1,8 @@
+/**
+ * Provides classes used to generate 
+ * <a href="https://plantuml.com/xearth" target="_top">
+ * XEarth Image</a>.
+ *
+ * @see {@link ext.plantuml.com.ctreber.acearth} 
+ */
+package net.sourceforge.plantuml.acearth;
diff --git a/src/net/sourceforge/plantuml/acearth/readme.md b/src/net/sourceforge/plantuml/acearth/readme.md
new file mode 100644
index 000000000..a369bb7a5
--- /dev/null
+++ b/src/net/sourceforge/plantuml/acearth/readme.md
@@ -0,0 +1,20 @@
+# Directory Documentation for `acearth`
+
+## Description
+This package provides classes used to generate [XEarth Image](https://plantuml.com/xearth).
+
+The Java port of `XEarth` used in `PlantUML` is the [`AC.earth` of Christian Treber](../../../../ext/plantuml/com/ctreber/acearth/).
+
+## Link
+- [XEarth Image _(on `PlantUML`)_](https://plantuml.com/xearth)
+
+## Reference
+- [`xearth` of Kirk Lauritz Johnson](https://hewgill.com/xearth/original/)
+- [`xearth` for Windows of Greg Hewgill](https://hewgill.com/xearth/)
+
+## Credit
+- [`AC.earth` of Christian Treber](../../../../ext/plantuml/com/ctreber/acearth/)
+- [AC Earth _(on Web Archive)_](https://web.archive.org/web/20180428011447/http://www.acproductions.de/acearth)
+
+## Misc.
+- [Earth Day _(on Wikipedia)_](https://en.wikipedia.org/wiki/Earth_Day)
diff --git a/src/net/sourceforge/plantuml/ant/package-info.java b/src/net/sourceforge/plantuml/ant/package-info.java
new file mode 100644
index 000000000..13c4b6bba
--- /dev/null
+++ b/src/net/sourceforge/plantuml/ant/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * Provides classes used to manage 
+ * <a href="https://plantuml.com/ant-task)" target="_top">
+ * PlantUML Ant task</a>.
+ *
+ */
+package net.sourceforge.plantuml.ant;
diff --git a/src/net/sourceforge/plantuml/ant/readme.md b/src/net/sourceforge/plantuml/ant/readme.md
index 1465cc435..cdc863943 100644
--- a/src/net/sourceforge/plantuml/ant/readme.md
+++ b/src/net/sourceforge/plantuml/ant/readme.md
@@ -5,5 +5,7 @@ This package provides classes used to manage [PlantUML Ant task](https://plantum
 
 ## Link
 - [PlantUML Ant task](https://plantuml.com/ant-task)
-- [Ant](https://ant.apache.org)
-- [Ant _(on Wikipedia)_](https://en.wikipedia.org/wiki/Apache_Ant)
+
+## Reference
+- [Apache Ant](https://ant.apache.org)
+- [Apache Ant _(on Wikipedia)_](https://en.wikipedia.org/wiki/Apache_Ant)
diff --git a/src/net/sourceforge/plantuml/argon2/package-info.java b/src/net/sourceforge/plantuml/argon2/package-info.java
new file mode 100644
index 000000000..13f96fd1f
--- /dev/null
+++ b/src/net/sourceforge/plantuml/argon2/package-info.java
@@ -0,0 +1,26 @@
+/**
+ * Provides classes used to manage the password-hashing function nammed
+ * <a href="https://github.com/andreas1327250/argon2-java" target="_top">
+ * Argon2</a>.
+ *
+ * <p>
+ * The code is taken from:
+ * <ul>
+ *  <li><a href="https://github.com/andreas1327250/argon2-java" target="_top">
+ *  Andreas1327250/Argon2-java</a></li>
+ *  <li><a href="https://github.com/alphazero/Blake2b/" target="_top">
+ *  Alphazero/Blake2b/</a></li>
+ * </ul>
+ * </p>
+ * <p>
+ * <i>Ref.</i>:
+ * <ul>
+ *  <li><a href="https://github.com/P-H-C/phc-winner-argon2" target="_top">
+ *  P-H-C/PHC-winner-argon2</a></li>
+ *  <li><a href="https://www.password-hashing.net" target="_top">
+ *  Password Hashing Competition (PHC)</a></li>
+ * </ul>
+ * </p>
+ *
+ */
+package net.sourceforge.plantuml.argon2;
diff --git a/src/net/sourceforge/plantuml/argon2/readme.md b/src/net/sourceforge/plantuml/argon2/readme.md
new file mode 100644
index 000000000..5b9c35e9a
--- /dev/null
+++ b/src/net/sourceforge/plantuml/argon2/readme.md
@@ -0,0 +1,22 @@
+# Directory Documentation for `argon2`
+
+## Description
+This package provides classes used to manage the password-hashing function nammed [Argon2](https://github.com/andreas1327250/argon2-java).
+
+## Link
+- [:octocat:Andreas1327250/Argon2-java](https://github.com/andreas1327250/argon2-java)
+
+## Reference
+- [Argon2 _(on Wikipedia)_](https://en.wikipedia.org/wiki/Argon2)
+- [RFC 9106 (Argon2)](https://datatracker.ietf.org/doc/html/rfc9106)
+- [:octocat:P-H-C/PHC-winner-argon2](https://github.com/P-H-C/phc-winner-argon2)
+- [Password Hashing Competition (PHC)](https://www.password-hashing.net)
+- [BLAKE2](https://www.blake2.net)
+- [RFC 7693 (BLAKE2)](https://datatracker.ietf.org/doc/html/rfc7693)
+
+## Credit
+- [:octocat:Andreas1327250/Argon2-java](https://github.com/andreas1327250/argon2-java)
+- [:octocat:Alphazero/Blake2b](https://github.com/alphazero/Blake2b/)
+
+## Misc.
+
diff --git a/src/net/sourceforge/plantuml/asciiart/package-info.java b/src/net/sourceforge/plantuml/asciiart/package-info.java
new file mode 100644
index 000000000..b2a812ff3
--- /dev/null
+++ b/src/net/sourceforge/plantuml/asciiart/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * Provides classes used to manage 
+ * <a href="https://plantuml.com/ascii-art" target="_top">
+ * ASCII Art output format</a>.
+ *
+ */
+package net.sourceforge.plantuml.asciiart;
diff --git a/src/net/sourceforge/plantuml/asciiart/readme.md b/src/net/sourceforge/plantuml/asciiart/readme.md
new file mode 100644
index 000000000..40bf00c90
--- /dev/null
+++ b/src/net/sourceforge/plantuml/asciiart/readme.md
@@ -0,0 +1,11 @@
+# Directory Documentation for `asciiart`
+
+## Description
+This package provides classes used to export diagram to an [ASCII Art](https://plantuml.com/ascii-art) output format.
+
+## Link
+- [ASCII Art Output Format](https://plantuml.com/ascii-art)
+- [ASCII Art _(on Wikipedia)_](https://en.wikipedia.org/wiki/ASCII_art)
+
+## Reference
+
diff --git a/src/net/sourceforge/plantuml/board/package-info.java b/src/net/sourceforge/plantuml/board/package-info.java
new file mode 100644
index 000000000..27c585a94
--- /dev/null
+++ b/src/net/sourceforge/plantuml/board/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * Provides classes used to manage 
+ * <a href="http://alphadoc.plantuml.com/doc/markdown/en/board-diagram" target="_top">
+ * Board Diagram</a>.
+ *
+ */
+package net.sourceforge.plantuml.board;
diff --git a/src/net/sourceforge/plantuml/board/readme.md b/src/net/sourceforge/plantuml/board/readme.md
new file mode 100644
index 000000000..0dad7ba78
--- /dev/null
+++ b/src/net/sourceforge/plantuml/board/readme.md
@@ -0,0 +1,11 @@
+# Directory Documentation for `board`
+
+## Description
+This package provides classes used to manage [PlantUML Board Diagram](http://alphadoc.plantuml.com/doc/markdown/en/board-diagram).
+
+## Link
+- [Board Diagram _(on Alpha-doc)_](http://alphadoc.plantuml.com/doc/markdown/en/board-diagram)
+
+## Reference
+- [GH-423](https://github.com/plantuml/plantuml/issues/423)
+
diff --git a/src/net/sourceforge/plantuml/bpm/package-info.java b/src/net/sourceforge/plantuml/bpm/package-info.java
new file mode 100644
index 000000000..ec737d116
--- /dev/null
+++ b/src/net/sourceforge/plantuml/bpm/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * Provides classes used to manage 
+ * <a href="http://alphadoc.plantuml.com/doc/markdown/en/bpmn" target="_top">
+ * BPMN (Business Process Model and Notation) Diagram</a>.
+ *
+ */
+package net.sourceforge.plantuml.bpm;
diff --git a/src/net/sourceforge/plantuml/bpm/readme.md b/src/net/sourceforge/plantuml/bpm/readme.md
new file mode 100644
index 000000000..ca4b43137
--- /dev/null
+++ b/src/net/sourceforge/plantuml/bpm/readme.md
@@ -0,0 +1,16 @@
+# Directory Documentation for `bpm`
+
+## Description
+This package provides classes used to manage [PlantUML BPMN diagram](http://alphadoc.plantuml.com/doc/markdown/en/bpmn).
+
+## Link
+- [BPMN Diagram _(on Alpha-doc)_](http://alphadoc.plantuml.com/doc/markdown/en/bpmn)
+- [BPMN _(on Wikipedia)_](https://en.wikipedia.org/wiki/Business_Process_Model_and_Notation)
+
+## Reference
+- [QA-5647](https://forum.plantuml.net/5647/plans-for-bpmn-support)
+
+## Credit
+
+## Misc.
+
diff --git a/src/net/sourceforge/plantuml/braille/package-info.java b/src/net/sourceforge/plantuml/braille/package-info.java
new file mode 100644
index 000000000..ce161668a
--- /dev/null
+++ b/src/net/sourceforge/plantuml/braille/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * Provides classes used to manage 
+ * <a href="https://plantuml.com/en/command-line#458de91d76a8569c" target="_top">
+ * Braille output format</a>.
+ *
+ */
+package net.sourceforge.plantuml.braille;
diff --git a/src/net/sourceforge/plantuml/braille/readme.md b/src/net/sourceforge/plantuml/braille/readme.md
new file mode 100644
index 000000000..5cea22da8
--- /dev/null
+++ b/src/net/sourceforge/plantuml/braille/readme.md
@@ -0,0 +1,11 @@
+# Directory Documentation for `braille`
+
+## Description
+This package provides classes used to export diagram to a [Braille](https://plantuml.com/en/command-line#458de91d76a8569c) output format.
+
+## Link
+- [PlantUML Braille Output Format](https://plantuml.com/en/command-line#458de91d76a8569c)
+
+## Reference
+- [QA-4752](https://forum.plantuml.net/4752/translate-class-diagram-to-braille)
+
diff --git a/src/net/sourceforge/plantuml/brotli/package-info.java b/src/net/sourceforge/plantuml/brotli/package-info.java
new file mode 100644
index 000000000..05e4f12ca
--- /dev/null
+++ b/src/net/sourceforge/plantuml/brotli/package-info.java
@@ -0,0 +1,15 @@
+/**
+ * Provides classes used to manage 
+ * <a href="https://github.com/google/brotli" target="_top">
+ * Brotli Compression Algorithm</a>.
+ *
+ * <p>
+ * The code is taken from:
+ * <ul>
+ *  <li><a href="https://github.com/google/brotli" target="_top">
+ *  Google/Brotli</a></li>
+ * </ul>
+ * </p>
+ * 
+ */
+package net.sourceforge.plantuml.brotli;
diff --git a/src/net/sourceforge/plantuml/brotli/readme.md b/src/net/sourceforge/plantuml/brotli/readme.md
new file mode 100644
index 000000000..43919430a
--- /dev/null
+++ b/src/net/sourceforge/plantuml/brotli/readme.md
@@ -0,0 +1,18 @@
+# Directory Documentation for `brotli`
+
+## Description
+This package provides classes used to manage [Brotli Compression Algorithm](https://github.com/google/brotli).
+
+## Link
+- [:octocat:Google/Brotli](https://github.com/google/brotli)
+
+## Reference
+- [Brotli _(on Wikipedia)_](https://en.wikipedia.org/wiki/Brotli)
+- [RFC 7932](https://datatracker.ietf.org/doc/html/rfc7932)
+
+## Credit
+- [:octocat:Google/Brotli](https://github.com/google/brotli)
+
+## Misc.
+- [Brötchen _(on Wikipedia)_](https://de.wikipedia.org/wiki/Br%C3%B6tchen)
+- [Bread roll _(on Wikipedia)_](https://en.wikipedia.org/wiki/Bread_roll)
diff --git a/src/net/sourceforge/plantuml/classdiagram/package-info.java b/src/net/sourceforge/plantuml/classdiagram/package-info.java
new file mode 100644
index 000000000..1e6f4621e
--- /dev/null
+++ b/src/net/sourceforge/plantuml/classdiagram/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * Provides classes used to manage 
+ * <a href="https://plantuml.com/class-diagram" target="_top">
+ * Class Diagram</a>.
+ *
+ */
+package net.sourceforge.plantuml.classdiagram;
diff --git a/src/net/sourceforge/plantuml/classdiagram/readme.md b/src/net/sourceforge/plantuml/classdiagram/readme.md
new file mode 100644
index 000000000..2d61f5688
--- /dev/null
+++ b/src/net/sourceforge/plantuml/classdiagram/readme.md
@@ -0,0 +1,14 @@
+# Directory Documentation for `classdiagram`
+
+## Description
+This package provides classes used to manage [PlantUML Class Diagram](https://plantuml.com/class-diagram).
+
+## Link
+- [Class Diagram](https://plantuml.com/class-diagram)
+
+## Reference
+
+## Credit
+
+## Misc.
+
diff --git a/src/net/sourceforge/plantuml/code/package-info.java b/src/net/sourceforge/plantuml/code/package-info.java
new file mode 100644
index 000000000..ab99d1cc9
--- /dev/null
+++ b/src/net/sourceforge/plantuml/code/package-info.java
@@ -0,0 +1,9 @@
+/**
+ * Provides classes used to manage Coding and Compression.
+ *
+ * @see {@link net.sourceforge.plantuml.brotli}
+ * @see {@link net.sourceforge.plantuml.code.deflate}
+ * @see {@link net.sourceforge.plantuml.zopfli}
+ *
+ */
+package net.sourceforge.plantuml.code;
diff --git a/src/net/sourceforge/plantuml/code/readme.md b/src/net/sourceforge/plantuml/code/readme.md
new file mode 100644
index 000000000..9e301b836
--- /dev/null
+++ b/src/net/sourceforge/plantuml/code/readme.md
@@ -0,0 +1,19 @@
+# Directory Documentation for `code`
+
+## Description
+This package provides classes used to manage Coding and Compression.
+
+## Link
+- [`brotli`](../brotli/)
+- [`code.deflate`](./deflate/)
+- [`zopfli`](../zopfli/)
+
+## Reference
+- [Simple DEFLATE decompressor](https://www.nayuki.io/page/simple-deflate-decompressor)
+- [RFC 1951 (DEFLATE)](https://datatracker.ietf.org/doc/html/rfc1951)
+
+## Credit
+- [:octocat:Nayuki/Simple-DEFLATE-decompressor](https://github.com/nayuki/Simple-DEFLATE-decompressor)
+
+## Misc.
+
diff --git a/src/net/sourceforge/plantuml/command/package-info.java b/src/net/sourceforge/plantuml/command/package-info.java
new file mode 100644
index 000000000..e78b77344
--- /dev/null
+++ b/src/net/sourceforge/plantuml/command/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * Provides classes used to manage PlantUML End User Common Command.
+ *
+ * @see {@link net.sourceforge.plantuml.regex}
+ *
+ */
+package net.sourceforge.plantuml.command;
diff --git a/src/net/sourceforge/plantuml/command/readme.md b/src/net/sourceforge/plantuml/command/readme.md
new file mode 100644
index 000000000..77edda8be
--- /dev/null
+++ b/src/net/sourceforge/plantuml/command/readme.md
@@ -0,0 +1,13 @@
+# Directory Documentation for `command`
+
+## Description
+This package provides classes used to manage PlantUML End User Common Command.
+
+## Link
+
+## Reference
+
+## Credit
+
+## Misc.
+
diff --git a/src/net/sourceforge/plantuml/ebnf/package-info.java b/src/net/sourceforge/plantuml/ebnf/package-info.java
new file mode 100644
index 000000000..0b7e661eb
--- /dev/null
+++ b/src/net/sourceforge/plantuml/ebnf/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * Provides classes used to manage 
+ * <a href="https://plantuml.com/ebnf" target="_top">
+ * EBNF (Extended Backus–Naur Form) Diagram</a>.
+ *
+ */
+package net.sourceforge.plantuml.ebnf;
diff --git a/src/net/sourceforge/plantuml/ebnf/readme.md b/src/net/sourceforge/plantuml/ebnf/readme.md
new file mode 100644
index 000000000..41d9366a3
--- /dev/null
+++ b/src/net/sourceforge/plantuml/ebnf/readme.md
@@ -0,0 +1,15 @@
+# Directory Documentation for `ebnf`
+
+## Description
+This package provides classes used to manage [Extended Backus–Naur Form (EBNF) Diagram](https://plantuml.com/ebnf).
+
+## Link
+- [Extended Backus–Naur Form (EBNF) Diagram](https://plantuml.com/ebnf)
+
+## Reference
+- [Extended Backus–Naur Form (EBNF) _(on Wikipedia)_](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form)
+
+## Credit
+
+## Misc.
+
diff --git a/src/net/sourceforge/plantuml/filesdiagram/package-info.java b/src/net/sourceforge/plantuml/filesdiagram/package-info.java
new file mode 100644
index 000000000..64dbd8b7a
--- /dev/null
+++ b/src/net/sourceforge/plantuml/filesdiagram/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * Provides classes used to manage 
+ * <a href="http://alphadoc.plantuml.com/doc/markdown/en/files-diagram" target="_top">
+ * [Tree] Files diagram</a>.
+ *
+ */
+package net.sourceforge.plantuml.filesdiagram;
diff --git a/src/net/sourceforge/plantuml/filesdiagram/readme.md b/src/net/sourceforge/plantuml/filesdiagram/readme.md
new file mode 100644
index 000000000..158fce745
--- /dev/null
+++ b/src/net/sourceforge/plantuml/filesdiagram/readme.md
@@ -0,0 +1,15 @@
+# Directory Documentation for `filesdiagram`
+
+## Description
+This package provides classes used to manage [[Tree] Files diagram](http://alphadoc.plantuml.com/doc/markdown/en/files-diagram).
+
+## Link
+- [[Tree] Files diagram _(on alpha-doc)_](http://alphadoc.plantuml.com/doc/markdown/en/files-diagram)
+
+## Reference
+- [GH-1448](https://github.com/plantuml/plantuml/issues/1448)
+
+## Credit
+
+## Misc.
+