readme revision
This commit is contained in:
parent
6dbd2d3b8d
commit
1df46d0662
47
README.md
47
README.md
@ -1,20 +1,45 @@
|
|||||||
# Tinyboard - A lightweight PHP imageboard.
|
Tinyboard -- A lightweight PHP imageboard.
|
||||||
|
==========================================
|
||||||
|
|
||||||
## About
|
Tinyboard is a light-weight, fast, highly configurable and user-friendly
|
||||||
Tinyboard is an imageboard software package written in PHP. It aims to maintain a stable, fast, clean, robust and user-friendly engine for imageboards. You can contact the development team or learn more at [tinyboard.org](http://tinyboard.org/) or on IRC at [irc.datnode.net #tinyboard](irc://irc.datnode.net/tinyboard).
|
imageboard software package released under a non-restrictive open-source
|
||||||
|
license. It is written in PHP and has few dependencies.
|
||||||
|
|
||||||
## Requirements
|
Requirements
|
||||||
|
------------
|
||||||
1. PHP >= 5.2.5
|
1. PHP >= 5.2.5
|
||||||
2. [mbstring](http://www.php.net/manual/en/mbstring.installation.php) (--enable-mbstring)
|
2. [mbstring](http://www.php.net/manual/en/mbstring.installation.php)
|
||||||
|
(--enable-mbstring)
|
||||||
3. [PHP-GD](http://php.net/manual/en/book.image.php)
|
3. [PHP-GD](http://php.net/manual/en/book.image.php)
|
||||||
4. [PHP-PDO](http://php.net/manual/en/book.pdo.php) with appropriate <del>[driver for your database](http://www.php.net/manual/en/pdo.drivers.php)</del> (only MySQL is supported at the moment)
|
4. [PHP-PDO](http://php.net/manual/en/book.pdo.php) with appropriate <del>[driver for your database](http://www.php.net/manual/en/pdo.drivers.php)</del> (only MySQL is supported at the moment)
|
||||||
|
|
||||||
## Installation
|
We try to make sure Tinyboard is compatible with all major web servers and
|
||||||
See <http://tinyboard.org/wiki/index.php?title=Installation>.
|
operating systems. Tinyboard does not include an Apache .htaccess file nor does
|
||||||
|
it need one.
|
||||||
|
|
||||||
## Documentation
|
Contributing
|
||||||
Documentation can be found at <http://tinyboard.org/docs/>.
|
------------
|
||||||
|
|
||||||
## License
|
|
||||||
See [LICENSE.md](http://github.com/savetheinternet/Tinyboard/blob/master/LICENSE.md) for the license.
|
Installation
|
||||||
|
-------------
|
||||||
|
See <http://tinyboard.org/docs/installation.html>.
|
||||||
|
|
||||||
|
Support
|
||||||
|
--------
|
||||||
|
Tinyboard is still beta software -- there are bound to be bugs. If you find a
|
||||||
|
bug, please report it.
|
||||||
|
|
||||||
|
If you need assistance with installing, configuring or using Tinyboard, you may
|
||||||
|
find support from a variety of sources:
|
||||||
|
|
||||||
|
* If you're unsure about how to enable or configure certain features, make
|
||||||
|
sure you have read the comments in ```inc/config.php```.
|
||||||
|
* Documentation can be found at <http://tinyboard.org/docs/>.
|
||||||
|
* You may join Tinyboard's IRC channel for support and general queries:
|
||||||
|
[irc.datnode.net #tinyboard](irc://irc.datnode.net/tinyboard).
|
||||||
|
|
||||||
|
License
|
||||||
|
--------
|
||||||
|
See [LICENSE.md](http://github.com/savetheinternet/Tinyboard/blob/master/LICENSE.md).
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user