added short documentation

master
BodgeMaster 2020-03-10 23:11:34 +01:00
parent dd2e9601f1
commit 0c39f2259c
1 changed files with 31 additions and 0 deletions

31
threadr/README.md Normal file
View File

@ -0,0 +1,31 @@
# Short documentation of each file
### about [DIR]
contains the about us page
### board [DIR]
contains the files needed to display a board
### boards [DIR]
contains the files for the board list
### img [DIR]
the directory that contains images that are part of the WebSite itself (no user content)
### login [DIR]
everything that is needed to log in a user
### logout [DIR]
the logout process
### news [DIR]
a page displaying a special board that is write-protected and shows updates about ThreadR
### profile [DIR]
profile pages and profile settings
### signup [DIR]
the signup process
### userhome [DIR]
the users feed
### accept_cookie.php
redirect immediately back to where tzhe user came from but sets a cookie that says 'You accept cookies.'
$_GET variables:
* from: the url the user came from after urlencode() was used on it
### index.php
the homepage
### README.md
this file
### style.css
the stylesheet used on every ThreadR site