Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added explanations to readme #1294

Merged
merged 7 commits into from Jul 24, 2020
Merged
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
39 changes: 26 additions & 13 deletions README.md
Expand Up @@ -2,23 +2,32 @@

In this repository, you can find the lang files for the framework PHP, [Laravel 4/5/6/7](https://laravel.com).

## New
## News

* in version 6.1, we propose a new file by language: `validation-inline.php` ( see #1268 )
* in version 7, we propose new directory names to follow ISO-15897 ( see #1269 )
* In Laravel version 6.1, we propose a new file by language: `validation-inline.php` ( see #1268 )
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, it's the version 6.1 of this project, not Laravel :)

* in Laravel version 7, we propose new directory names to follow ISO-15897 ( see #1269 )
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the same, the version 7 of this project

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why would one be interested in installing an old version of this project?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This project is used by other projects to install easier the files. And some updates, like directory names, can break this projects.

Then, some versions are depending on Laravel version.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, so I revert these changes.


## Install

#### Via Composer
* For Laravel 7.x and new directory names : run `composer require caouecs/laravel-lang:~7.0` in your project folder
* For Laravel 7.x : run `composer require caouecs/laravel-lang:~6.1` in your project folder
* For Laravel 6.x : run `composer require caouecs/laravel-lang:~5.0` in your project folder
* For Laravel 5.8 : run `composer require caouecs/laravel-lang:~4.0` in your project folder
* For Laravel 5.1-5.7 : run `composer require caouecs/laravel-lang:~3.0` in your project folder
* For Laravel 5 : run `composer require caouecs/laravel-lang:~2.0` in your project folder
* For Laravel 4 : run `composer require caouecs/laravel-lang:~1.0` in your project folder
* Files of languages are in "vendor/caouecs/laravel-lang" directory
* Copy the folders of languages that you want, in the *resources/lang* folder of your Laravel application (*app/lang* in Laravel 4).
Install the Laravel-lang package to your Laravel project with composer using command from the table below based on the version of Laravel you are using:

| Laravel version | Composer command |
| --------------------------------------- | -------------------------------------------- |
| Laravel 7.x and new directory names | `composer require caouecs/laravel-lang:~7.0` |
| Laravel 7.x | `composer require caouecs/laravel-lang:~6.1` |
| Laravel 6.x | `composer require caouecs/laravel-lang:~5.0` |
| Laravel 5.8 | `composer require caouecs/laravel-lang:~4.0` |
| Laravel 5.1-5.7 | `composer require caouecs/laravel-lang:~3.0` |
| Laravel 5 | `composer require caouecs/laravel-lang:~2.0` |
| Laravel 4 | `composer require caouecs/laravel-lang:~1.0` |


##### Copy files
After adding the dependency using composer (as described above) to your application you can find the language files under the directory `vendor/caouecs/laravel-lang`.

Copy the folders (and JSON files) of languages that you want to use, into the directory `resources/lang` of your Laravel application (or `app/lang` in Laravel 4).


#### Via GitHub

Expand All @@ -27,7 +36,8 @@ In this repository, you can find the lang files for the framework PHP, [Laravel
* Choose the branch:
* `laravel4` for Laravel 4 project
* `master` for Laravel 5, 6, 7 projects
* Copy the folders of languages that you want, in *resources/lang* folder of your Laravel application (*app/lang* in Laravel 4).
* Copy the folders of languages that you want, in `resources/lang` folder of your Laravel application (or `app/lang` in Laravel 4).


#### Via SVN

Expand All @@ -43,6 +53,7 @@ svn export https://github.com/caouecs/Laravel-lang/branches/laravel4/[language-c

Replace `[language-code]` by any of the languages listed [here](src).


## Usage [Laravel only]

In the file *config/app.php*, change the value of *locale* by the short name of your language (*app/config/app.php* in Laravel 4).
Expand All @@ -52,10 +63,12 @@ In the file *config/app.php*, change the value of *locale* by the short name of

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.


## Status of files

* Check the [todo.md](todo.md) file to see the missing translations.


## Projects based on this package

* [LaravelLang by ARCANEDEV](https://github.com/ARCANEDEV/LaravelLang) - Translations manager and checker for Laravel.
Expand Down