lainchan/README.md

80 lines
2.8 KiB
Markdown
Raw Normal View History

2012-08-30 11:35:17 -04:00
Tinyboard - A lightweight PHP imageboard.
2012-03-11 14:17:15 -04:00
==========================================
Tinyboard + vichan-devel
------------
Tinyboard branch taking lightweightness somewhat more liberally. Running live at
https://pl.vichan.net/ (Polish) and http://vichan.net/ (International; may be outdated).
It contains many changes from original Tinyboard, mainly in frontend area.
2013-08-20 21:58:44 -04:00
Support and announcements: https://int.vichan.net/devel/
2012-08-30 11:35:17 -04:00
About
------------
2013-08-16 07:48:05 -04:00
Tinyboard is a free light-weight, fast, highly configurable and user-friendly
imageboard software package. It is written in PHP and has few dependencies.
2012-03-11 14:17:15 -04:00
Requirements
------------
1. PHP >= 5.2.5
2013-07-31 00:29:49 -04:00
2. MySQL server
3. [mbstring](http://www.php.net/manual/en/mbstring.installation.php)
4. [PHP GD](http://www.php.net/manual/en/intro.image.php)
5. [PHP PDO](http://www.php.net/manual/en/intro.pdo.php)
2011-01-19 21:48:53 -05:00
2012-03-11 14:17:15 -04:00
We try to make sure Tinyboard is compatible with all major web servers and
2012-03-11 14:26:19 -04:00
operating systems. Tinyboard does not include an Apache ```.htaccess``` file nor does
2012-03-11 14:17:15 -04:00
it need one.
2013-07-31 00:29:49 -04:00
### Recommended
1. PHP >= 5.3
2. MySQL server >= 5.5.3
3. ImageMagick or command-line version (```convert``` and ```identify```)
4. [APC (Alternative PHP Cache)](http://php.net/manual/en/book.apc.php), [XCache](http://xcache.lighttpd.net/) or [Memcached](http://www.php.net/manual/en/intro.memcached.php)
2012-03-11 14:17:15 -04:00
Contributing
------------
2012-08-26 12:52:31 -04:00
You can contribute to Tinyboard by:
* Developing patches/improvements/translations and using GitHub to submit pull requests
* Providing feedback and suggestions
* Writing/editing documentation
2012-08-28 03:23:10 -04:00
2012-08-26 12:52:31 -04:00
If you need help developing a patch, please join our IRC channel.
2012-03-11 14:17:15 -04:00
Installation
-------------
2012-03-11 14:26:19 -04:00
1. Download and extract Tinyboard to your web directory or get the latest
development version with:
2012-03-11 23:11:52 -04:00
2012-03-11 23:21:44 -04:00
git clone git://github.com/savetheinternet/Tinyboard.git
2012-03-11 14:27:40 -04:00
2012-03-11 14:26:19 -04:00
2. Navigate to ```install.php``` in your web browser and follow the
prompts.
3. Tinyboard should now be installed. Log in to ```mod.php``` with the
2012-03-11 23:21:44 -04:00
default username and password combination: **admin / password**.
Please remember to change the administrator account password.
See also: [Configuration Basics](http://tinyboard.org/docs/?p=Config).
2012-03-11 14:26:19 -04:00
2012-03-11 14:17:15 -04:00
Support
--------
Tinyboard is still beta software -- there are bound to be bugs. If you find a
bug, please report it.
2012-03-11 23:21:44 -04:00
If you need assistance with installing, configuring, or using Tinyboard, you may
2012-03-11 14:17:15 -04:00
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```.
2012-03-11 14:26:19 -04:00
* Documentation can be found [here](http://tinyboard.org/docs/).
* You can join Tinyboard's IRC channel for support and general queries:
2012-03-11 14:17:15 -04:00
[irc.datnode.net #tinyboard](irc://irc.datnode.net/tinyboard).
2013-07-31 00:29:49 -04:00
* You may find help at [tinyboard.org](http://tinyboard.org/#help).
2012-03-11 14:17:15 -04:00
License
--------
See [LICENSE.md](http://github.com/savetheinternet/Tinyboard/blob/master/LICENSE.md).
2011-10-11 17:11:15 -04:00