From 3f419bf6db7497a7a9be156ae6fbd010c7db05ef Mon Sep 17 00:00:00 2001
From: Stefano Pigozzi <ste.pigozzi@gmail.com>
Date: Fri, 31 Jul 2020 17:38:50 +0200
Subject: [PATCH] Add folder READMEs

---
 examplepack/commands/README.md | 5 +++++
 examplepack/events/README.md   | 5 +++++
 examplepack/stars/README.md    | 5 +++++
 examplepack/tables/README.md   | 5 +++++
 examplepack/types/README.md    | 9 +++++++++
 examplepack/utils/README.md    | 7 +++++++
 6 files changed, 36 insertions(+)
 create mode 100644 examplepack/commands/README.md
 create mode 100644 examplepack/events/README.md
 create mode 100644 examplepack/stars/README.md
 create mode 100644 examplepack/tables/README.md
 create mode 100644 examplepack/types/README.md
 create mode 100644 examplepack/utils/README.md

diff --git a/examplepack/commands/README.md b/examplepack/commands/README.md
new file mode 100644
index 00000000..f986573e
--- /dev/null
+++ b/examplepack/commands/README.md
@@ -0,0 +1,5 @@
+## The commands folder
+
+The commands folder should contain all commands that your Pack will add to the Royalnet instances it is installed in.
+
+To learn how to create a new Command, read the [`command` docs page](https://gh.steffo.eu/royalnet/html/packs/command.html).
diff --git a/examplepack/events/README.md b/examplepack/events/README.md
new file mode 100644
index 00000000..7ddca5ef
--- /dev/null
+++ b/examplepack/events/README.md
@@ -0,0 +1,5 @@
+## The events folder
+
+The events folder should contain all events (remote procedure calls) that your Pack will add to the Royalnet instances it is installed in.
+
+To learn how to create a new Event, read the [`event` docs page](https://gh.steffo.eu/royalnet/html/packs/event.html).
diff --git a/examplepack/stars/README.md b/examplepack/stars/README.md
new file mode 100644
index 00000000..fece4c4b
--- /dev/null
+++ b/examplepack/stars/README.md
@@ -0,0 +1,5 @@
+## The stars folder
+
+The stars folder should contain all stars (webserver routes) that your Pack will add to the Royalnet instances it is installed in.
+
+To learn how to create a new PageStar, read the [`star` docs page](https://gh.steffo.eu/royalnet/html/packs/star.html).
diff --git a/examplepack/tables/README.md b/examplepack/tables/README.md
new file mode 100644
index 00000000..f0bc2273
--- /dev/null
+++ b/examplepack/tables/README.md
@@ -0,0 +1,5 @@
+## The tables folder
+
+The tables folder should contain all Alchemy tables (SQLAlchemy-compatible SQL tables) that your Pack will add to the Royalnet instances it is installed in.
+
+To learn how to create a new table, read the [`table` docs page](https://gh.steffo.eu/royalnet/html/packs/table.html).
diff --git a/examplepack/types/README.md b/examplepack/types/README.md
new file mode 100644
index 00000000..0ffa090c
--- /dev/null
+++ b/examplepack/types/README.md
@@ -0,0 +1,9 @@
+## The types folder
+
+The types folder should contain the enums and custom types that are used in your tables.
+
+Please note that the contents of this folder are imported **before** everything else in the pack.
+
+Its contents **can be imported anywhere** in the Pack, including the `tables` folder, without creating a circular import.
+
+However, its files are **forbidden from importing anything else** from the rest of the pack!
diff --git a/examplepack/utils/README.md b/examplepack/utils/README.md
new file mode 100644
index 00000000..e850998d
--- /dev/null
+++ b/examplepack/utils/README.md
@@ -0,0 +1,7 @@
+## The utils folder
+
+The utils folder should contain the utility functions and classes that your Pack uses.
+
+Its contents are imported **before** the commands, events and stars but **after** the tables, so **you can't import them** in the files contained in the `tables` folder, or you will create a [circular import](https://stackabuse.com/python-circular-imports/)!
+
+Files in this folder are **forbidden from importing modules** from the `commands`, `events` and `stars` folders, as that will create a circular import too.