kashire/lainchan
4
0
Fork 0
Code Issues 1 Pull Requests Releases Wiki Activity

readme

Browse Source
This commit is contained in:
Savetheinternet 2011-03-28 16:27:18 +11:00
parent 4555c4bf6a
commit a16d62ca83
1 changed files with 5 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -1,9 +1,7 @@
# Tinyboard - A lightweight PHP imageboard. # Tinyboard - A lightweight PHP imageboard.
## About ## About
Tinyboard is an imageboard software package written in PHP. It aims to maintain a stable, fast, clean and user-friendly engine for imageboards. Development for Tinyboard started in October 2010. You can contact the development team over IRC at [tinyboard.org][o] or on IRC at [irc.datnode.net #tinyboard][i]. Tinyboard is an imageboard software package written in PHP. It aims to maintain a stable, fast, clean and user-friendly engine for imageboards. Development for Tinyboard started in October 2010. You can contact the development team or learn more at [tinyboard.org][o] or on IRC at [irc.datnode.net #tinyboard][i].
Tinyboard is not currently at a stable state.
[o]: http://tinyboard.org/ [o]: http://tinyboard.org/
[i]: irc://irc.datnode.net/tinyboard [i]: irc://irc.datnode.net/tinyboard
@ -14,28 +12,13 @@ Tinyboard is not currently at a stable state.
3. php-pdo with appropriate driver for your database 3. php-pdo with appropriate driver for your database
## Installation ## Installation
1. Tinyboard requires an SQL database and a user to work. Create one. See [http://tinyboard.org/wiki/index.php?title=Installation][i].
2. Import 'install.sql' into the database. There are several ways to do this. [i]: http://tinyboard.org/wiki/
- using phpMyAdmin
- `mysql -uUSERNAME -pPASSWORD DATABASE < install.sql`
3. Edit 'instance-config.php' to suit your installation. You should copy some values from '[inc/config.php][c]' to redefine them in the instance-config.
4. Make sure that the Tinyboard directory is writable. Depending on your setup, you may need to `chmod` "." to 777, with `chmod 777 .`
5. Ensure everything is okay by running [test.php][t] in a browser. The script will try and help you correct your errors.
6. Run the [post.php][p] script. It should create an index.html and redirect you to it if everything is okay.
7. Optional (highly recommended): Either delete or chmod as unreadable the following files: [test.php][t], [install.sql][i], and this [README][r].
An automated installation script will be completed soon.
[t]: http://github.com/savetheinternet/Tinyboard/blob/master/test.php
[p]: http://github.com/savetheinternet/Tinyboard/blob/master/post.php
[c]: http://github.com/savetheinternet/Tinyboard/blob/master/inc/config.php
[i]: http://github.com/savetheinternet/Tinyboard/blob/master/install.sql
[r]: http://github.com/savetheinternet/Tinyboard/blob/master/README.md
## Documentation ## Documentation
Visit the development wiki at [http://tinyboard.org/wiki/][o] for help. Visit the development wiki at [http://tinyboard.org/wiki/][o] for help.
[o]: http://tinyboard.org/ [o]: http://tinyboard.org/wiki/
## License ## License
See [LICENSE.md][l] for license. See [LICENSE.md][l] for the license.
[l]: http://github.com/savetheinternet/Tinyboard/blob/master/README.md [l]: http://github.com/savetheinternet/Tinyboard/blob/master/README.md