leftypol
/
leftypol
4
5
Fork 2
Code Issues 58 Pull Requests 1 Projects Releases Wiki Activity
Browse Source

Update 'README.md'

pull/40/head
adminuser 3 years ago
parent
d46d785962
commit
da07d0211f
1 changed files with 28 additions and 31 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 59
      README.md

59
README.md
View File

@ -1,53 +1,50 @@
Lainchan - A fork of vichan leftypol - vichan/lainchan based imageboard software
======================================================== ========================================================
About About
------------ ------------
Lainchan is a fork of [vichan](http://github.com/vichan-devel/vichan), The leftypol imageboard is a fork of [lainchan](http://github.com/lainchan/lainchan), a fork of [vichan](http://github.com/vichan-devel/vichan), actively building on it and adding features, bug-fixes and other
a great imageboard package, actively building on it and adding a lot of features and other
improvements. improvements.
We highly recommend you read the [vichan GitHub wiki](http://github.com/vichan-devel/vichan/wiki) for a basic guide to features.
Requirements Requirements
------------ ------------
1. PHP >= 5.4 (we still try to keep compatibility with php 5.3 as much as possible) 1. PHP >= 5.4. PHP 7.0 is explicitly supported. There is a PHP 8 capable branch.
PHP 7.0 is explicitly supported. 2. MySQL/MariaDB server >= 5.5.3
2. MySQL/MariaDB server
3. [mbstring](http://www.php.net/manual/en/mbstring.installation.php) 3. [mbstring](http://www.php.net/manual/en/mbstring.installation.php)
4. [PHP GD](http://www.php.net/manual/en/intro.image.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) 5. [PHP PDO](http://www.php.net/manual/en/intro.pdo.php)
We try to make sure lainchan is compatible with all major web servers and This should be compatible with all major web servers and
operating systems. lainchan does not include an Apache ```.htaccess``` file nor does operating systems. This code does not include an Apache ```.htaccess``` file nor does
it need one. it need one.
### Recommended ### Recommended
1. MySQL/MariaDB server >= 5.5.3 1. ImageMagick (command-line ImageMagick or GraphicsMagick preferred).
2. ImageMagick (command-line ImageMagick or GraphicsMagick preferred). 2. [APC (Alternative PHP Cache)](http://php.net/manual/en/book.apc.php),
3. [APC (Alternative PHP Cache)](http://php.net/manual/en/book.apc.php),
[XCache](http://xcache.lighttpd.net/) or [XCache](http://xcache.lighttpd.net/) or
[Memcached](http://www.php.net/manual/en/intro.memcached.php) [Memcached](http://www.php.net/manual/en/intro.memcached.php)
Contributing Contributing
------------ ------------
You can contribute to lainchan by: You can contribute to leftypol, and upstream imageboard softwares, by:
* Developing patches/improvements/translations and using GitHub to submit pull requests * Developing patches/improvements/translations and using this repo to submit pull requests
* Providing feedback and suggestions * Providing feedback and suggestions
* Writing/editing documentation * Writing/editing documentation
If you need help developing a patch, please join our IRC channel. If you need help developing a patch, please reply to the sticky on our [/tech/](https://leftypol.org/tech/) board.
> irc.lainchan.org:6697 @ #thecage
Installation Installation
------------- -------------
1. Download and extract lainchan to your web directory or get the latest 1. Download and extract leftypol to your web directory or get the latest
development version with: development version with:
git clone git://github.com/lainchan/lainchan.git git clone git://git.leftypol.org/adminuser/leftypol.git
2. Navigate to ```install.php``` in your web browser and follow the 2. Navigate to ```install.php``` in your web browser and follow the
prompts. prompts.
3. lainchan should now be installed. Log in to ```mod.php``` with the 3. leftypol should now be installed. Log in to ```mod.php``` with the
default username and password combination: **admin / password**. default username and password combination: **admin / password**.
Please remember to change the administrator account password. Please remember to change the administrator account password.
@ -56,30 +53,30 @@ See also: [Configuration Basics](https://web.archive.org/web/20121003095922/http
Upgrade Upgrade
------- -------
To upgrade from any version of Tinyboard or vichan: This probably will break if you try and upgrade from vichan or the older (<= August 2021) leftypol versions. Ask us for migration advice if you intend to do so.
To upgrade from this repo:
Either run ```git pull``` to update your files, if you used git, or 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 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 (don't remove boards etc.), then put ```inc/instance-config.php``` back and
finally run ```install.php```. finally run ```install.php```.
To migrate from a Kusaba X board, use http://github.com/vichan-devel/Tinyboard-Migration To migrate from a Kusaba X board, use http://github.com/vichan-devel/Tinyboard-Migration (untested)
Support Support
-------- --------
If you find a bug, please report it. If you find a bug, please report it.
If you need assistance with installing, configuring, or using lainchan, you may If you need assistance with installing, configuring, or using leftypol, you may
find support from a variety of sources: find support from a variety of sources:
* If you're unsure about how to enable or configure certain features, make * If you're unsure about how to enable or configure certain features, make
sure you have read the comments in ```inc/config.php```. sure you have read the comments in ```inc/config.php```.
* You can join lainchan's IRC channel for support * For support, reply to the sticky on our [/tech/](https://leftypol.org/tech/) board.
[irc.freenode.net #lainchan](irc://irc.freenode.net/lainchan)
### Tinyboard support ### Tinyboard support
vichan, and by extension lainchan, is based on a Tinyboard, so both engines have very much in common. These vichan, and by extension lainchan and leftypol, is based on a Tinyboard, so both engines have very much in common. These links may be helpful for you as well:
links may be helpful for you as well:
* Tinyboard documentation can be found [here](https://web.archive.org/web/20121016074303/http://tinyboard.org/docs/?p=Main_Page). * Tinyboard documentation can be found [here](https://web.archive.org/web/20121016074303/http://tinyboard.org/docs/?p=Main_Page).
@ -95,13 +92,13 @@ at the power users. You won't be able to run these from shared hosting accounts
Localisation Localisation
------------ ------------
Wanting to have lainchan in your language? You can contribute your translations to vichan at this URL: Wanting to have leftypol in your language? You can contribute your translations to vichan at this URL:
https://www.transifex.com/projects/p/tinyboard-vichan-devel/ https://www.transifex.com/projects/p/tinyboard-vichan-devel/
Oekaki Oekaki
------ ------
lainchan makes use of [wPaint](https://github.com/websanova/wPaint) for oekaki. After you pull the repository, however, you will need to download wPaint separately using git's `submodule` feature. Use the following commands: leftypol makes use of [wPaint](https://github.com/websanova/wPaint) for oekaki. After you pull the repository, however, you will need to download wPaint separately using git's `submodule` feature. Use the following commands:
``` ```
git submodule init git submodule init
@ -114,12 +111,12 @@ WebM support
------------ ------------
Read `inc/lib/webm/README.md` for information about enabling webm. Read `inc/lib/webm/README.md` for information about enabling webm.
lainchan API leftypol API
---------- ----------
lainchan provides by default a 4chan-compatible JSON API, just like vichan. For documentation on this, see: leftypol provides by default a 4chan-compatible JSON API, just like vichan. For documentation on this, see:
https://github.com/vichan-devel/vichan-API/ . https://github.com/vichan-devel/vichan-API/ .
License License
-------- --------
See [LICENSE.md](http://github.com/lainchan/lainchan/blob/master/LICENSE.md). See LICENSE.md.

Write Preview
Loading…
Cancel
Save