From d70cf6e3db193dfe7d19246e689e3340a943989c Mon Sep 17 00:00:00 2001
From: BodgeMaster <>
Date: Thu, 12 Mar 2020 22:57:54 +0100
Subject: [PATCH] more file documentation

---
 threadr/board/README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 threadr/board/README.md

diff --git a/threadr/board/README.md b/threadr/board/README.md
new file mode 100644
index 0000000..a3da531
--- /dev/null
+++ b/threadr/board/README.md
@@ -0,0 +1,19 @@
+# A short overview of the files:
+### index.php
+Somewhat obvious...
+$_GET values:
+  * id → the board id
+  * action → what action file should be loaded in the bottom section (see below)
+    * valid actions: [not present], post, submit, edit
+### board.php
+the top part of a board page, displays the posts, loaded via include()
+### post.php
+one of the action files for the bottom of the page, displays a form to add a post, loaded via include()
+### submit.php
+displays a message in the bottom of the page and submits a new post, loaded via include()
+### edit.php
+? [Will look into it later, seems not to do very much ATM]
+### default.php
+displays a button giving the user the option to post something
+### README.md
+this file