Skip to content

Commit

Permalink
feature: doc
Browse files Browse the repository at this point in the history
  • Loading branch information
caouecs committed Aug 23, 2020
1 parent 2cb9932 commit 8e4fc86
Show file tree
Hide file tree
Showing 6 changed files with 108 additions and 34 deletions.
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ This Code of Conduct applies both within project spaces and in public spaces whe

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Contributions are **welcome** and will be fully **credited**.

We accept contributions via Pull Requests on [Github](https://github.com/caouecs/Laravel-lang).
We accept contributions via Pull Requests on [Github](https://github.com/Laravel-Lang/Laravel-lang).

## How can I add a language in this project ?

Expand Down
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# The MIT License (MIT)

Copyright (c) 2020 caouecs <[email protected]>
Copyright (c) 2020 Laravel-Lang team

> Permission is hereby granted, free of charge, to any person obtaining a copy
> of this software and associated documentation files (the "Software"), to deal
Expand Down
51 changes: 23 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,65 +9,60 @@ In this repository, you can find the lang files for the framework PHP, [Laravel

## Install

#### Via Composer
### Via Composer

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

#### Copy files

##### 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`.
After adding the dependency using composer (as described above) to your application you can find the language files under the directory `vendor/laravel-lang/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

#### Via GitHub

* Clone the [GitHub repository](https://github.com/caouecs/laravel-lang/) : *git clone https://github.com/caouecs/Laravel-lang.git*
* Or download the [zip file](https://github.com/caouecs/laravel-lang/archive/master.zip)
* Clone the [GitHub repository](https://github.com/Laravel-Lang/Laravel-lang/) : *git clone https://github.com/Laravel-Lang/Laravel-lang.git*
* Or download the [zip file](https://github.com/Laravel-Lang/Laravel-lang/archive/master.zip)
* 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 (or `app/lang` in Laravel 4).


#### Via SVN
### Via SVN

Run this in your project directory:

```sh
# Laravel 5:
svn export https://github.com/caouecs/Laravel-lang/trunk/src/[language-code] resources/lang/[language-code]
svn export https://github.com/Laravel-Lang/Laravel-lang/trunk/src/[language-code] resources/lang/[language-code]

# Laravel 4:
svn export https://github.com/caouecs/Laravel-lang/branches/laravel4/[language-code] app/lang/[language-code]
svn export https://github.com/Laravel-Lang/Laravel-lang/branches/laravel4/[language-code] app/lang/[language-code]
```

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).


## Contributing

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

Please see [CONTRIBUTING](https://github.com/Laravel-Lang/Laravel-lang/CONTRIBUTING.md) for details.

## Status of files

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

* Check the [todo.md](https://github.com/Laravel-Lang/Laravel-lang/todo.md) file to see the missing translations.

## Projects based on this package

Expand All @@ -77,5 +72,5 @@ Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Credits

- [caouecs](https://github.com/caouecs)
- [All Contributors](https://github.com/caouecs/Laravel-lang/graphs/contributors)
- [Referents by language](https://github.com/Laravel-Lang/Laravel-lang/referents.md)
- [All Contributors](https://github.com/Laravel-Lang/Laravel-lang/graphs/contributors)
6 changes: 3 additions & 3 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{
"name": "caouecs/laravel-lang",
"name": "laravel-lang/laravel-lang",
"description": "Languages for Laravel",
"keywords": ["laravel", "languages", "lpm", "lang"],
"license": "MIT",
"authors": [
{
"name": "caouecs",
"email": "[email protected]"
"name": "Laravel-Lang Team",
"url": "https://github.com/Laravel-Lang"
}
],
"suggest": {
Expand Down
79 changes: 79 additions & 0 deletions referents.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# Referents by language

| Lang | Assignee |
| --- |:--|
| ar | |
| az | |
| be | |
| bg | |
| bn | |
| bs | |
| ca | |
| cs | |
| cy | |
| da | @jensstigaard |
| de | @WhereIsLucas |
| de_CH | |
| el | |
| es | |
| et | |
| eu | |
| fa | |
| fi | |
| fil | |
| fr | @caouecs, @WhereIsLucas |
| gl | |
| he | |
| hi | |
| hr | |
| hu | |
| hy | |
| id | |
| is | |
| it | |
| ja | |
| ka | |
| kk | |
| km | |
| kn | |
| ko | |
| lt | |
| lv | |
| me | |
| mk | |
| mn | |
| mr | |
| ms | |
| nb | |
| ne | |
| nl | @WhereIsLucas |
| nn | |
| pl | |
| ps | |
| pt | @jorgercosta |
| pt_BR | |
| ro | |
| ru | @andrey-helldar |
| sc | |
| si | |
| sk | |
| sl | |
| sq | |
| sr_Cyrillic | |
| sr_Latin | |
| sv | |
| sw | |
| tg | |
| th | |
| tk | |
| tl | |
| tr | |
| ug | |
| uk | @MrAlKuz |
| ur | |
| uz_Cyrillic | |
| uz_Latin | |
| vi | |
| zh_CN | @overtrue |
| zh_HK | @overtrue |
| zh_TW | @overtrue |

0 comments on commit 8e4fc86

Please sign in to comment.