Code style fixes.
This commit is contained in:
parent
82e356f0f8
commit
b3197b47f2
|
@ -1,5 +1,4 @@
|
||||||
Change Log
|
# Change Log
|
||||||
==========
|
|
||||||
|
|
||||||
## [PHP Censor v0.18.0](https://github.com/corpsee/php-censor/tree/0.18.0) (2017-10-22)
|
## [PHP Censor v0.18.0](https://github.com/corpsee/php-censor/tree/0.18.0) (2017-10-22)
|
||||||
|
|
||||||
|
|
|
@ -1,8 +1,6 @@
|
||||||
Contribution Guidelines
|
# Contribution Guidelines
|
||||||
=======================
|
|
||||||
|
|
||||||
Coding Standards
|
## Coding Standards
|
||||||
----------------
|
|
||||||
|
|
||||||
The code is written to follow
|
The code is written to follow
|
||||||
[PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) standards.
|
[PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) standards.
|
||||||
|
|
|
@ -1,19 +1,15 @@
|
||||||
Expected behaviour
|
## Expected behavior
|
||||||
------------------
|
|
||||||
|
|
||||||
*Please describe what you're expecting to see happen.*
|
*Please describe what you're expecting to see happen.*
|
||||||
|
|
||||||
Actual behaviour
|
## Actual behavior
|
||||||
----------------
|
|
||||||
|
|
||||||
*Please describe what you're actually seeing happen.*
|
*Please describe what you're actually seeing happen.*
|
||||||
|
|
||||||
Steps to reproduce
|
## Steps to reproduce
|
||||||
------------------
|
|
||||||
|
|
||||||
*If your issue requires any specific steps to reproduce, please outline them here.*
|
*If your issue requires any specific steps to reproduce, please outline them here.*
|
||||||
|
|
||||||
Environment info
|
## Environment
|
||||||
----------------
|
|
||||||
|
|
||||||
*OS, PHP version, MySQL/PostgreSQL version.*
|
*OS, PHP version, MySQL/PostgreSQL version.*
|
||||||
|
|
|
@ -1,9 +1,7 @@
|
||||||
Contribution Typ
|
## Contribution type
|
||||||
----------------
|
|
||||||
|
|
||||||
*Bug fix, new plugin, feature, ui etc.*
|
*Bug fix, new plugin, feature, ui etc.*
|
||||||
|
|
||||||
Description of change
|
## Description of change
|
||||||
---------------------
|
|
||||||
|
|
||||||
*Detailed description of change.*
|
*Detailed description of change.*
|
||||||
|
|
30
README.md
30
README.md
|
@ -27,8 +27,7 @@ More [screenshots](docs/en/screenshots.md).
|
||||||
* [Documentation](#documentation)
|
* [Documentation](#documentation)
|
||||||
* [License](#license)
|
* [License](#license)
|
||||||
|
|
||||||
System requirements
|
## System requirements
|
||||||
-------------------
|
|
||||||
|
|
||||||
* Unix-like OS (**Windows isn't supported**);
|
* Unix-like OS (**Windows isn't supported**);
|
||||||
|
|
||||||
|
@ -40,8 +39,7 @@ System requirements
|
||||||
|
|
||||||
* Beanstalkd queue (Optional);
|
* Beanstalkd queue (Optional);
|
||||||
|
|
||||||
Features
|
## Features
|
||||||
--------
|
|
||||||
|
|
||||||
* Clone project from Github, Bitbucket, Gitlab, Git, Mercurial, SVN or from local directory;
|
* Clone project from Github, Bitbucket, Gitlab, Git, Mercurial, SVN or from local directory;
|
||||||
|
|
||||||
|
@ -62,8 +60,7 @@ CopyBuild, Deployer, Env, Git, Grunt, Gulp, PackageBuild, Phar, Phing, Shell and
|
||||||
|
|
||||||
* Use your LDAP-server for authentication;
|
* Use your LDAP-server for authentication;
|
||||||
|
|
||||||
Installing
|
## Installing
|
||||||
----------
|
|
||||||
|
|
||||||
* Go to the directory in which you want to install PHP Censor, for example: `/var/www`:
|
* Go to the directory in which you want to install PHP Censor, for example: `/var/www`:
|
||||||
|
|
||||||
|
@ -109,14 +106,12 @@ PHP Censor directory. You'll need to set up rewrite rules to point all non-exist
|
||||||
* [Set up the PHP Censor Worker](docs/en/workers/worker.md) (Need configured Queue) or
|
* [Set up the PHP Censor Worker](docs/en/workers/worker.md) (Need configured Queue) or
|
||||||
[a cron-job](docs/en/workers/cron.md) to run PHP Censor builds;
|
[a cron-job](docs/en/workers/cron.md) to run PHP Censor builds;
|
||||||
|
|
||||||
Installing via Docker
|
## Installing via Docker
|
||||||
--------------------
|
|
||||||
|
|
||||||
If you want to install PHP Censor as Docker container, you can use
|
If you want to install PHP Censor as Docker container, you can use
|
||||||
[php-censor/docker-php-censor](https://github.com/php-censor/docker-php-censor) project.
|
[php-censor/docker-php-censor](https://github.com/php-censor/docker-php-censor) project.
|
||||||
|
|
||||||
Updating
|
## Updating
|
||||||
--------
|
|
||||||
|
|
||||||
* Go to your PHP Censor directory (to `/var/www/php-censor.local` for example):
|
* Go to your PHP Censor directory (to `/var/www/php-censor.local` for example):
|
||||||
|
|
||||||
|
@ -163,8 +158,7 @@ Updating
|
||||||
sudo systemctl restart <worker@n.service>
|
sudo systemctl restart <worker@n.service>
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuring project
|
## Configuring project
|
||||||
-------------------
|
|
||||||
|
|
||||||
There are several ways to set up the project:
|
There are several ways to set up the project:
|
||||||
|
|
||||||
|
@ -198,8 +192,7 @@ complete:
|
||||||
|
|
||||||
More details about [configuring project](docs/en/configuring_project.md).
|
More details about [configuring project](docs/en/configuring_project.md).
|
||||||
|
|
||||||
Migrations
|
## Migrations
|
||||||
----------
|
|
||||||
|
|
||||||
Run to apply latest migrations:
|
Run to apply latest migrations:
|
||||||
|
|
||||||
|
@ -215,8 +208,7 @@ cd /path/to/php-censor
|
||||||
./bin/console php-censor-migrations:create NewMigrationName
|
./bin/console php-censor-migrations:create NewMigrationName
|
||||||
```
|
```
|
||||||
|
|
||||||
Tests
|
## Tests
|
||||||
-----
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd /path/to/php-censor
|
cd /path/to/php-censor
|
||||||
|
@ -234,12 +226,10 @@ For database B8Framework tests create empty 'b8_test' database on 'localhost' wi
|
||||||
for MySQL and with user/password: `postgres/<empty>'` for PostgreSQL (You can change default test user, password and
|
for MySQL and with user/password: `postgres/<empty>'` for PostgreSQL (You can change default test user, password and
|
||||||
database name in `phpunit.mysql|pgsql.xml` config). If connection failed tests will be skipped.
|
database name in `phpunit.mysql|pgsql.xml` config). If connection failed tests will be skipped.
|
||||||
|
|
||||||
Documentation
|
## Documentation
|
||||||
-------------
|
|
||||||
|
|
||||||
[Full PHP Censor documentation](docs/en/README.md).
|
[Full PHP Censor documentation](docs/en/README.md).
|
||||||
|
|
||||||
License
|
## License
|
||||||
-------
|
|
||||||
|
|
||||||
PHP Censor is open source software licensed under the [BSD-2-Clause license](LICENSE.md).
|
PHP Censor is open source software licensed under the [BSD-2-Clause license](LICENSE.md).
|
||||||
|
|
Loading…
Reference in a new issue