github/torrentpier
1
0
Fork 0
mirror of https://github.com/torrentpier/torrentpier synced 2025-08-22 06:13:58 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

docs(README): clarify PHP version requirements and installation instructions

Browse source 
- Updated PHP version requirements to specify that PHP 8.2+ is required for development dependencies.
- Enhanced installation instructions to differentiate between production and development setups, including commands for Composer installation.
- Added a note regarding the necessity of PHP 8.2+ for running tests, improving clarity for developers.

These changes aim to provide clearer guidance for users setting up their development environments.
This commit is contained in:
Yury Pikhtarev 2025-06-20 23:04:59 +04:00
commit 134c183c72
No known key found for this signature in database
1 changed files with 8 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -57,7 +57,7 @@ and go from there. The documentation will be translated to English in the near f
* Apache / nginx ([example config](install/nginx.conf)) / caddy ([example config](install/Caddyfile)) * Apache / nginx ([example config](install/nginx.conf)) / caddy ([example config](install/Caddyfile))
* MySQL 5.5.3 or above (including MySQL 8.0+) / MariaDB 10.0 or above / Percona * MySQL 5.5.3 or above (including MySQL 8.0+) / MariaDB 10.0 or above / Percona
* PHP: 8.1 / 8.2 / 8.3 / 8.4 * PHP: 8.1 / 8.2 / 8.3 / 8.4 (8.2+ required for development dependencies)
* PHP Extensions: mbstring, gd, bcmath, intl, tidy (optional), xml, xmlwriter * PHP Extensions: mbstring, gd, bcmath, intl, tidy (optional), xml, xmlwriter
* Crontab (Recommended) * Crontab (Recommended)
@ -98,6 +98,10 @@ Check out our [autoinstall](https://github.com/torrentpier/autoinstall) reposito
3. [Check our system requirements](#-requirements) 3. [Check our system requirements](#-requirements)
4. After, run this command in the project directory to install Composer dependencies 4. After, run this command in the project directory to install Composer dependencies
```shell ```shell
# For production (PHP 8.1+)
composer install --no-dev
# For development (PHP 8.2+ required)
composer install composer install
``` ```
5. Edit database configuration settings in the environment (`.env.example`), after, rename to `.env` 5. Edit database configuration settings in the environment (`.env.example`), after, rename to `.env`
@ -132,6 +136,9 @@ If you discover a security vulnerability within TorrentPier, please follow our [
TorrentPier includes a comprehensive testing suite built with **Pest PHP**. Run tests to ensure code quality and system reliability: TorrentPier includes a comprehensive testing suite built with **Pest PHP**. Run tests to ensure code quality and system reliability:
> [!NOTE]
> Testing requires **PHP 8.2+** and development dependencies. Install with `composer install` (without `--no-dev` flag).
```shell ```shell
# Run all tests # Run all tests
./vendor/bin/pest ./vendor/bin/pest