Yeeeeee! It’s done. All files have a short description now.

master
BodgeMaster 2020-03-12 23:51:03 +01:00
parent 4c6ede19a3
commit 1e6155042f
10 changed files with 50 additions and 1 deletions

View File

@ -1,3 +1,5 @@
# Short documentation of all files
### index.php
Self-Explanatory
### README.md
this file

5
threadr/boards/README.md Normal file
View File

@ -0,0 +1,5 @@
# Short description of each file
### index.php
obvious, hopefully
### README.md
this file

View File

@ -3,3 +3,5 @@
This is my usual nope.html to prevent kiddies from poking at my files. It just redirects. There is no real security benefit to it though as it does not even prevent `wget -r`.
### *.{svg,png,jpg}
images that are used on the page
### README.md
this file

7
threadr/login/README.md Normal file
View File

@ -0,0 +1,7 @@
# A short description of each file
### index.php
should be obvious, accepts a $_GET variable to display error messages: error=<credentials|session>
### README.md
this file
### redirect.php
does some tasks for login and redirects to the users personal feed page

View File

@ -1,3 +1,5 @@
# Short documentation of all files
### index.php
Self-Explanatory
### README.md
this file

5
threadr/news/README.md Normal file
View File

@ -0,0 +1,5 @@
# Short description of each file
### index.php
Well, guess what?
### README.md
this file

10
threadr/profile/README.md Normal file
View File

@ -0,0 +1,10 @@
# Short documentation of each file
### index.php
Fairly obvious, if you ask me.
Accepts a $_GET variable: action=<[not present]|edit>
### default.php
shown by default, loaded via include()
### edit.php
profile edit page, loaded via include()
### README.md
this file

7
threadr/signup/README.md Normal file
View File

@ -0,0 +1,7 @@
# Short description for each file
### verify-email [DIR] the folder containing the email verification page
### index.php
You can figure that out on your own.
Interesting fact about this page: Will force-logout the user without notice.
### README.md
this file

View File

@ -0,0 +1,7 @@
# Files
### index.php
obvious
### redirect.php
activates the user after the email has been verified
### README.md
this file

View File

@ -1,3 +1,5 @@
# Short documentation of all files
## Short documentation of all files
### index.php
Self-Explanatory
### README.md
this file