diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 36 |
1 files changed, 25 insertions, 11 deletions
@@ -6,14 +6,15 @@ About vichan is a free light-weight, fast, highly configurable and user-friendly imageboard software package. It is written in PHP and has few dependencies. -vichan is a fork of [Tinyboard](http://tinyboard.org/), a great imageboard package, actively -building on it and adding a lot of features and other improvements. +vichan is a fork of (now defunc'd) [Tinyboard](http://github.com/savetheinternet/Tinyboard), +a great imageboard package, actively building on it and adding a lot of features and other +improvements. -Support and announcements: https://int.vichan.net/devel/ +Support and announcements: https://engine.vichan.net/ Requirements ------------ -1. PHP >= 5.3 +1. PHP >= 5.4 (we still try to keep compatibility with php 5.3 as much as possible) 2. MySQL/MariaDB server 3. [mbstring](http://www.php.net/manual/en/mbstring.installation.php) 4. [PHP GD](http://www.php.net/manual/en/intro.image.php) @@ -55,9 +56,20 @@ Please remember to change the administrator account password. See also: [Configuration Basics](http://tinyboard.org/docs/?p=Config). +Upgrade +------- +To upgrade from any version of Tinyboard or vichan: + +Either run ```git pull``` to update your files, if you used git, or +backup your ```inc/instance-config.php```, replace all your files in place +(don't remove boards etc.), then put ```inc/instance-config.php``` back and +finally run ```install.php```. + +To migrate from a Kusaba X board, use http://github.com/vichan-devel/Tinyboard-Migration + Support -------- -Tinyboard is still beta software -- there are bound to be bugs. If you find a +vichan 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 vichan, you may @@ -73,15 +85,12 @@ find support from a variety of sources: vichan is based on a Tinyboard, so both engines have very much in common. These links may be helpful for you as well: -* Tinyboard documentation can be found [here](http://tinyboard.org/docs/). -* You can join Tinyboard's IRC channel for support and general queries: - [irc.datnode.net #tinyboard](irc://irc.datnode.net/tinyboard). -* You may find help at [tinyboard.org](http://tinyboard.org/#help). +* Tinyboard documentation can be found [here](https://web.archive.org/web/20121016074303/http://tinyboard.org/docs/?p=Main_Page). Donations --------- Do you like our work? You can motivate us financially to do better ;) -* Bitcoin: [](http://tip4commit.com/projects/708) +* Bitcoin: 1GjZEdLaTQ8JWVFGZW921Yv4x59f9oiZME You can also ask us to develop some feature specially for you <3. Join our IRC channel and ask for a quote (there are a few of us, who work with the codebase @@ -112,12 +121,17 @@ git submodule init git submodule update ``` -To enable oekaki, add all the scripts listed in `js/oekaki.js` to your `instance-config.php`. +To enable oekaki, add all the scripts listed in `js/wpaint.js` to your `instance-config.php`. WebM support ------------ Read `inc/lib/webm/README.md` for information about enabling webm. +vichan API +---------- +vichan provides by default a 4chan-compatible JSON API. For documentation on this, see: +https://github.com/vichan-devel/vichan-API/ . + License -------- See [LICENSE.md](http://github.com/vichan-devel/vichan/blob/master/LICENSE.md). |