Skip to content

Commit 44453b7

Browse files
committed
Update Readme.md for better looks and recent status
1 parent 2f5d75e commit 44453b7

1 file changed

Lines changed: 40 additions & 19 deletions

File tree

README.md

Lines changed: 40 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,40 @@
1-
# phpBB Translation Validator - master-dev
1+
# phpBB Translation Validator
22

3-
This console application allows you to validate [phpBB](https://www.phpbb.com) language packages.
3+
With the help of this command line application you are able
4+
to validate [phpBB](https://www.phpbb.com) language packs.
5+
This application runs on your local machine and can be integrated
6+
into a [GitHub](https://www.github.com) repository.
47

5-
## Requirements
8+
## 📋Requirements
69

7-
This tool requires PHP 8.1 or above.
10+
This tool requires PHP 8.1 or above. In addition it needs several
11+
symfony and other packages, which need to be downloaded and installed with [Composer](https://getcomposer.org).
812

9-
### Installation
1013

11-
Firstly, download the latest British English (`en`) [language pack from phpBB.com](http://www.phpbb.com/customise/db/translation/british_english/) as this is the default source language. Then clone this repository and download the dependencies:
14+
## 🏗️ Installation
15+
16+
Clone this repository:
1217

1318
git clone https://github.com/phpbb/phpbb-translation-validator.git
19+
20+
Install the dependencies with Composer:
21+
1422
composer.phar install
1523

16-
For the easiest results, create a directory called `4.0` in the root of the Translation Validator. Upload the `en` language page into this directory, along with the languages you wish to test. Which leads e.g. to:
24+
Create a directory called `4.0` in the root of the Translation Validator. Afterwards download
25+
the [British English language pack](http://www.phpbb.com/customise/db/translation/british_english/)
26+
and put its content into ``4.0/en/``. Do the same with the languages you wish to test. Which leads e.g. to:
1727

1828
phpbb-translation-validator/4.0/en/
1929
phpbb-translation-validator/4.0/de/
30+
phpbb-translation-validator/4.0/fr/
2031
phpbb-translation-validator/translation.php
2132

22-
The simplest way to validate is to then run this command (the final argument is the language you wish to test and that has already been uploaded to the `4.0` directory; eg. `fr` for French):
33+
## ⚗️ Validate language packs
34+
35+
The simplest way to validate this language packages,
36+
is to open a command line tool in the validator directory.
37+
Then run this command (the final argument is the language you wish to test and that has already been stored to the `4.0` directory; e.g. `fr` for French):
2338

2439
php translation.php validate fr
2540

@@ -31,15 +46,15 @@ There are more arguments that can be supplied. For example, suppose you wanted t
3146
--safe-mode
3247
--display-notices
3348

34-
The `--safe-mode` flag indicates that you want to parse files instead of directly including them. This is useful if you want to run validations on a web server.
49+
The `--safe-mode` flag indicates that you want to parse files instead of directly including them.
50+
This is useful if you want to run validations on a web server.
3551

36-
If you are missing the English language files for the official Viglink extension, they can be easily donwloaded using this command:
52+
If you are missing the English language files for the official Viglink extension,
53+
they can be easily donwloaded using this command:
3754

3855
php translation.php download --files=phpbb-extensions/viglink --phpbb-version=4.0
3956

40-
## Tests
41-
42-
![GitHub Actions CI](https://github.com/phpbb/phpbb-translation-validator/actions/workflows/phpunit.yaml/badge.svg?branch=master)
57+
## 🛠️ Integration to your Repository
4358

4459
In your project you can add phpBB Translation Validator as a dependency:
4560

@@ -53,18 +68,24 @@ Then add a `php vendor/bin/translation.php` call to your workflow.
5368

5469
We use GitHub Actions as a continuous integration server and phpunit for our unit testing.
5570

71+
### 🏠 Local phpunit execution
72+
5673
To run the unit tests locally, use this command:
5774

5875
php vendor/phpunit/phpunit/phpunit tests/
5976

60-
## Contributing
77+
## 🤖 Tests
78+
79+
![GitHub Actions CI](https://github.com/phpbb/phpbb-translation-validator/actions/workflows/phpunit.yaml/badge.svg?branch=master)
80+
81+
## 🧑‍💻 Contributing
6182

62-
If you notice any problems with this application, please raise an issue at https://github.com/phpbb/phpbb-translation-validator/issues.
83+
If you notice any problems with this application, please raise an issue at the [Github-Repository](https://github.com/phpbb/phpbb-translation-validator/issues).
6384

64-
To submit your own code contributions, please fork the project and submit a pull request at https://github.com/phpbb/phpbb-translation-validator/pulls.
85+
To submit your own code contributions, please fork the project and submit a pull request at [Github-Repository](https://github.com/phpbb/phpbb-translation-validator/pulls).
6586

66-
When a new version is released, the version number will be updated in `composer.json` and `translation.php`. A new tag will be created and the package will become available at https://packagist.org/packages/phpbb/translation-validator.
87+
When a new version is released, the version number will be updated in `composer.json` and `translation.php`. A new tag will be created and the package will become available at [Packagist](https://packagist.org/packages/phpbb/translation-validator).
6788

68-
## License
89+
## 📜 License
6990

70-
[GPLv2](license.txt)
91+
[GNU General Public License v2](license.txt)

0 commit comments

Comments
 (0)