diff --git a/FRENCH/CONTRIBUTING.md b/FRENCH/CONTRIBUTING.md index 6650b71d95..19e5366df0 100644 --- a/FRENCH/CONTRIBUTING.md +++ b/FRENCH/CONTRIBUTING.md @@ -7,7 +7,7 @@ We need to coordinate us with the main English terms translations. In this purpose, please refer to the file `/FRENCH/src/translation-terms.md` -when you need to translate a technicial term. +when you need to translate a technical term. *(PS : see the next process `Add a translation term` on this same page)* @@ -33,7 +33,7 @@ in English. Please limit each line of Markdown file to 80 characters (including spaces). You can write your file as you want, but it would be nice to use a tool like [https://www.dcode.fr/text-splitter](https://www.dcode.fr/text-splitter) on your -translated paragraphs before commiting. +translated paragraphs before committing. ### Punctuation @@ -41,6 +41,18 @@ Please use a [non-breaking space](https://en.wikipedia.org/wiki/Non-breaking_spa instead of space on punctuation who need this space before (like `:`, `!`, `?`, ...). +## Tools + +We recommend to use the following tools : + +- [Microsoft Visual Studio Code](https://code.visualstudio.com/) for writing + code, and improve it with following extensions : + - [`davidanson.vscode-markdownlint`](https://marketplace.visualstudio.com/items?itemName=davidanson.vscode-markdownlint) + - [`moshfeu.compare-folders`](https://marketplace.visualstudio.com/items?itemName=moshfeu.compare-folders) + - [`rust-lang.rust`](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust) +- [Nadaclair BonPatron.com](https://bonpatron.com/) for proofreading +- [Deepl](https://www.deepl.com/translator) for translations + ## Processes ### Translate flow @@ -76,22 +88,22 @@ instead of space on punctuation who need this space before (like `:`, `!`, `?`, paragraph. - Please quickly read following `Guidelines` currently on this page. - A little tip : the [deepl.com](https://www.deepl.com/) translator. -10. (optionnal) Limit each line of your translation to 80 characters, thank to a +10. (optional) Limit each line of your translation to 80 characters, thank to a tool like [https://www.dcode.fr/text-splitter](https://www.dcode.fr/text-splitter). -11. (optionnal) `cd FRENCH && mdbook build && cd ..` (build the book in +11. (optional) `cd FRENCH && mdbook build && cd ..` (build the book in `/FRENCH/book`). Open its index.html file in your browser, and check its correctness. It also should help you for next task. -12. (optionnal) self-proofreading your work thank to services like +12. (optional) self-proofreading your work thank to services like [bonpatron.fr](https://bonpatron.com). 13. `git add -A && git commit -m ""` (committing your work) -14. (optionnal) `git rebase -i HEAD~` +14. (optional) `git rebase -i HEAD~` (squash all your commits into one commit) 15. `git push origin` (pushing your work on your fork) 16. In GitHub, create a new pull request from your fork to the main translation repository, in order to mark your work ready for a proofreading. -17. After someone proofreading it (and eventualy some edits), it would be +17. After someone proofreading it (and eventually some edits), it would be merged on `french-release` branch. ### Update your fork with another fork diff --git a/FRENCH/listings-sources/README.md b/FRENCH/listings-sources/README.md index e8218d418c..8b5f9ae890 100644 --- a/FRENCH/listings-sources/README.md +++ b/FRENCH/listings-sources/README.md @@ -3,42 +3,42 @@ Here are the English code sources that we translated after in [`/FRENCH/listings`][] folder. -It should be a copy of [`/listings`][], but it is very usefull when updating +It should be a copy of [`/listings`][], but it is very useful when updating English book, to know which (translated) code needs to be updated thank to `diff`-like tools ! ## Example > Suppose that there is some code update in ... -> +> > [`/listings/ch02-guessing-game-tutorial/listing-02-01/src/main.rs`][] -> +> > ... in the English Book. --- > So the files ... -> +> > [`/FRENCH/listings-sources/ch02-guessing-game-tutorial/listing-02-01/src/main.rs`][] -> +> > ... AND ... -> +> > [`/FRENCH/listings/ch02-guessing-game-tutorial/listing-02-01/src/main.rs`][] -> +> > ... are now outdated. --- > You need to update the translated code ... -> +> > [`/FRENCH/listings-sources/ch02-guessing-game-tutorial/listing-02-01/src/main.rs`][] -> +> > ... and then also update ... -> +> > [`/FRENCH/listings/ch02-guessing-game-tutorial/listing-02-01/src/main.rs`][] -> +> > ... in order to match with last updated code in ... -> +> > [`/listings/ch02-guessing-game-tutorial/listing-02-01/src/main.rs`][]. diff --git a/FRENCH/listings/README.md b/FRENCH/listings/README.md index cdfe7d7470..402ada4521 100644 --- a/FRENCH/listings/README.md +++ b/FRENCH/listings/README.md @@ -17,9 +17,9 @@ Consider the following Markdown code, in ```` > It should import and show code from file ... -> +> > [`/FRENCH/listings/ch02-guessing-game-tutorial/listing-02-01/src/main.rs`][] -> +> > ... between `// ANCHOR: io` and `// ANCHOR_END: io` tags. Potential processed result by `mdbook build` in the page which uses this diff --git a/README.md b/README.md index 4805545027..fb89a5fdc1 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,14 @@ -> # Le langage de programmation Rust +> # 📖 Le langage de programmation Rust > -> **This is the french translation of the book "The Rust Programming Language"** +> **🌐 This is the french translation of the book "The Rust Programming Language"** > -> *English Book : [https://github.com/rust-lang/book](https://github.com/rust-lang/book)* +> [👓 Click here to read this translated book online](https://jimskapt.github.io/rust-book-fr/) > -> Translations are inside `/FRENCH/` folder. Everything else should be remaing as the English Book (except this README.md). +> *[🔗 Click here to go to the English Book repository](https://github.com/rust-lang/book)* +> +> Translations are inside [`/FRENCH/`](https://github.com/Jimskapt/rust-book-fr/tree/french-release/FRENCH) +> folder. Everything else should be remaining as the English Book *(except some +> necessary files, like this README.md)*. > > Want to help to translate ? > Please read the file