diff options
Diffstat (limited to 'doc/readme.md')
| -rw-r--r-- | doc/readme.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/readme.md b/doc/readme.md new file mode 100644 index 0000000..547826e --- /dev/null +++ b/doc/readme.md @@ -0,0 +1,12 @@ +This folder contains general information relating to the game's source code. + +|File|Description| +|--------|-------| +|compile-fixes.md | Steps on how to fix some common compilation errors | +|hosting-flask.md | Example website that hosts the web client using [Flask](https://flask.palletsprojects.com/)| +|hosting-webclient.md | Explains how to integrate the web client into your own website | +|modules.md | Provides a summary about the modules that constitute the game's code| +|plugin-dev.md | Explains how to compile a simple plugin for the game | +|portability.md | Provides information about porting this game to other platforms | +|style.md | Explains the style guidelines that the source code generally follows | +|strings.md | Provides details about the custom string type used by this game | \ No newline at end of file |