diff --git a/README.md b/README.md index 4eef10815e..01f52aff85 100755 --- a/README.md +++ b/README.md @@ -1,33 +1,33 @@ # Note -Original repository is [javascript-tutorial-en](https://github.com/iliakan/javascript-tutorial-en) -This repository is created for Japanese translation. +Original repository is [javascript-tutorial-en](https://github.com/iliakan/javascript-tutorial-en). +This repository provides the Japanese translation of the "Modern JavaScript Tutorial". # The JavaScript Tutorial -This repository hosts the content of the Modern JavaScript Tutorial, published at [https://javascript.info](https://javascript.info). +This repository hosts the source content of the Modern JavaScript Tutorial, published at [https://javascript.info](https://javascript.info). ## Translations - Russian: [https://github.com/iliakan/javascript-tutorial-ru](https://github.com/iliakan/javascript-tutorial-ru). - Chinese: the ongoing translation at [https://github.com/iliakan/javascript-tutorial-cn](https://github.com/iliakan/javascript-tutorial-cn), go ahead and join if you know Chinese. -If you'd like to translate it into your language then fork the English tutorial and go ahead. I can publish the translation with your credits on a domain like fr.javascript.info. +If you'd like to translate it into your language, then fork the English tutorial. I can publish the translation with proper credit on a domain such as fr.javascript.info. -Please use this repository to file issues and suggest PRs for the text. +Please use this repository to report issues and submit pull requests for the text. ## Structure -Every chapter, article or a task has its folder. +Every chapter, article, or task has its own folder. -The folder is named like `N-url`, where `N` is a number for the sorting purposes and `url` is the URL part with title of the material. +Folders are named in the format `N-url`, where `N` is a number used for sorting, and `url` is the URL-friendly title of the material. -The type of the material is defined by the file inside the folder: +The type of each material is determined by the file contained in the folder: - - `index.md` stands for a chapter - - `article.md` stands for an article - - `task.md` stands for a task (solution must be provided in `solution.md` file aswell) +- `index.md` indicates a chapter +- `article.md` indicates an article +- `task.md` indicates a task (its solution should be provided in a `solution.md` file as well) -Each of these files starts from the `# Main header`. +Each of these files begins with a top-level `#` header. -Assets required for the material reside in the same folder. +All assets required for the material are stored in the same folder.