Skip to content

Commit 0897c70

Browse files
committed
Update README to better match the purpose of this repo
1 parent aada3a3 commit 0897c70

File tree

1 file changed

+8
-12
lines changed

1 file changed

+8
-12
lines changed

README.md

+8-12
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# reactjs.org
22

3-
This repo contains the source code and documentation powering [reactjs.org](https://reactjs.org/).
3+
This repo contains the source code and documentation powering [reactjs.org](https://reactjs.org/) in its French version.
44

55
## Getting started
66

@@ -10,11 +10,11 @@ This repo contains the source code and documentation powering [reactjs.org](http
1010
1. Node: any 8.x version starting with 8.4.0 or greater
1111
1. Yarn: See [Yarn website for installation instructions](https://yarnpkg.com/lang/en/docs/install/)
1212
1. A fork of the repo (for any contributions)
13-
1. A clone of the [reactjs.org repo](https://github.com/reactjs/reactjs.org) on your local machine
13+
1. A clone of the [fr.reactjs.org repo](https://github.com/reactjs/fr.reactjs.org) on your local machine
1414

1515
### Installation
1616

17-
1. `cd reactjs.org` to go into the project root
17+
1. `cd fr.reactjs.org` to go into the project root
1818
1. `yarn` to install the website's npm dependencies
1919

2020
### Running locally
@@ -24,9 +24,11 @@ This repo contains the source code and documentation powering [reactjs.org](http
2424

2525
## Contributing
2626

27+
Please, checkout issue #1 for specifics on contributing to the localization effort.
28+
2729
### Guidelines
2830

29-
The documentation is divided into several sections with a different tone and purpose. If you plan to write more than a few sentences, you might find it helpful to get familiar with the [contributing guidelines](https://github.com/reactjs/reactjs.org/blob/master/CONTRIBUTING.md#guidelines-for-text) for the appropriate sections.
31+
This repo is meant to provide French translation for the [reactjs.org](https://reactjs.org/) web site, changes should be limited to L10N features only (mostly string translation). To make deeper changes in the structure or the content of the web site, please consider contributing to the [reactjs.org repo](https://github.com/reactjs/reactjs.org).
3032

3133
### Create a branch
3234

@@ -51,19 +53,13 @@ The documentation is divided into several sections with a different tone and pur
5153

5254
1. `git add -A && git commit -m "My message"` (replacing `My message` with a commit message, such as `Fixed header logo on Android`) to stage and commit your changes
5355
1. `git push my-fork-name the-name-of-my-branch`
54-
1. Go to the [reactjs.org repo](https://github.com/reactjs/reactjs.org) and you should see recently pushed branches.
56+
1. Go to the [fr.reactjs.org repo](https://github.com/reactjs/fr.reactjs.org) and you should see recently pushed branches.
5557
1. Follow GitHub's instructions.
5658
1. If possible, include screenshots of visual changes. A Netlify build will also be automatically created once you make your PR so other people can see your change.
5759

58-
## Translation
59-
60-
If you are interesting in translating `reactjs.org`, please join the Crowdin.
61-
62-
* [Crowdin - React](https://crowdin.com/project/react)
63-
6460
## Troubleshooting
6561

6662
- `yarn reset` to clear the local cache
6763

6864
## License
69-
Content submitted to [reactjs.org](https://reactjs.org/) is CC-BY-4.0 licensed, as found in the [LICENSE-DOCS.md](https://github.com/open-source-explorer/reactjs.org/blob/master/LICENSE-DOCS.md) file.
65+
Content submitted to [fr.reactjs.org](https://reactjs.org/) is CC-BY-4.0 licensed, as found in the [LICENSE-DOCS.md](https://github.com/open-source-explorer/reactjs.org/blob/master/LICENSE-DOCS.md) file.

0 commit comments

Comments
 (0)