ryg/royalnet
ryg/royalnet
1
Fork 0
mirror of https://github.com/RYGhub/royalnet.git synced 2024-11-23 11:34:18 +00:00
Code Activity

Add folder READMEs

Browse source
This commit is contained in:
Steffo 2020-07-31 17:38:50 +02:00
parent f97bf35b75
commit 3f419bf6db
6 changed files with 36 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
examplepack/commands/README.md Normal file
View file

@ -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).

5
examplepack/events/README.md Normal file
View file

@ -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).

5
examplepack/stars/README.md Normal file
View file

@ -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).

5
examplepack/tables/README.md Normal file
View file

@ -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).

9
examplepack/types/README.md Normal file
View file

@ -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!

7
examplepack/utils/README.md Normal file
View file

@ -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.