diff options
| author | Savetheinternet <savetheinternet@n0v4.com> | 2010-11-04 01:04:30 +1100 |
|---|---|---|
| committer | Savetheinternet <savetheinternet@n0v4.com> | 2010-11-04 01:04:30 +1100 |
| commit | a2b1b1c6b9179fb8c515dc3957f357053536ee83 (patch) | |
| tree | 97ae2a0f86478bedb1aa1d0c3a1105d2910e1293 /README.md | |
| parent | d1ad51a84d46d23be652f5b899ba1884909680f2 (diff) | |
Updated README.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 00000000..c1a5bf08 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# Tinyboard - A lightweight PHP imageboard.
+
+## Installation
+ 1. Tinyboard requires a MySQL database and a user to work. Create one.
+ 2. Import 'install.sql' into the database
+ using phpMyAdmin
+ OR
+ mysql -uUSERNAME -pPASSWORD DATABASE < install.sql
+ 3. Edit 'inc/config.php' to suit your installation
+ 4. Make sure that the directories used by TinyBoard are writable. Depending on your setup, you may need to chmod the directories to 777.
+ The default directories are
+ - /res
+ - /src
+ - /thumb
+ You will also need to chmod the root directory so that static HTML files like index.html can be made.
+ 5. Ensure everything is okay by running test.php in a browser. The script will try and help you correct your errors.
+ 6. Run the post.php script. It should create an index.html and redirect you to it if everything is okay.
+ 7. Optional (highly recommended): Delete test.php and perhaps install.sql and this README
+
|