leftypol/leftypol
1
2
Fork 1
Code Issues 42 Pull requests 7 Projects Releases Packages Wiki Activity Actions

README: add test instructions

Browse source
This commit is contained in:
Zankaria 2025-04-18 12:08:32 +02:00
parent 46352a87c8
commit 7e7949fbc8
1 changed files with 7 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -14,7 +14,7 @@ Requirements
PHP 8.0 is explicitly supported. PHP 7.x should be compatable. PHP 8.0 is explicitly supported. PHP 7.x should be compatable.
2. MySQL/MariaDB server >= 5.5.3 2. MySQL/MariaDB server >= 5.5.3
3. [Composer](https://getcomposer.org/) (To install various packages) 3. [Composer](https://getcomposer.org/) (To install various packages)
4. [mbstring](http://www.php.net/manual/en/mbstring.installation.php) 4. [mbstring](http://www.php.net/manual/en/mbstring.installation.php)
5. [PHP GD](http://www.php.net/manual/en/intro.image.php) 5. [PHP GD](http://www.php.net/manual/en/intro.image.php)
6. [PHP PDO](http://www.php.net/manual/en/intro.pdo.php) 6. [PHP PDO](http://www.php.net/manual/en/intro.pdo.php)
@ -44,7 +44,7 @@ Installation
development version with: development version with:
git clone git://git.leftypol.org/leftypol/leftypol.git git clone git://git.leftypol.org/leftypol/leftypol.git
2. run ```composer install``` inside the directory 2. run ```composer install``` inside the directory
3. Navigate to ```install.php``` in your web browser and follow the 3. Navigate to ```install.php``` in your web browser and follow the
prompts. prompts.
@ -80,7 +80,7 @@ find support from a variety of sources:
* For support, reply to the sticky on our [/tech/](https://leftypol.org/tech/) board. * For support, reply to the sticky on our [/tech/](https://leftypol.org/tech/) board.
### Tinyboard support ### Tinyboard support
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: 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:
* 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).
@ -120,7 +120,10 @@ leftypol API
leftypol 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/ .
Testing
----------
You can run PHPUnit tests with `./vendor/bin/phpunit tests` with PHP 7.4 to 8.2.
License License
-------- --------
See LICENSE.md. See LICENSE.md.