Skip to content

Commit e127b85

Browse files
iliakaniliakan
authored
Update README.md
1 parent e386697 commit e127b85

1 file changed

Lines changed: 14 additions & 15 deletions

File tree

‎README.md‎

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ This is a standalone server for the javascript tutorial https://javascript.info.
66

77
You can use it to run the tutorial locally and translate it into your language.
88

9+
Windows, Unix-systems and MacOS are supported. For Windows, you'll need to call scripts with ".cmd" extension, that are present in the code alongside with Unix versions.
10+
911
# Installation
1012

1113
(If you have an old copy of the English tutorial, please rename `1-js/05-data-types/09-destructuring-assignment/1-destructuring-assignment` to `1-js/05-data-types/09-destructuring-assignment/1-destruct-user`).
@@ -16,9 +18,7 @@ You can use it to run the tutorial locally and translate it into your language.
1618
These are required to update and run the project.
1719
For Windows just download and install, otherwise use standard OS install tools (packages or whatever convenient).
1820

19-
Please use Node.JS 10.
20-
21-
If you're using Node.JS 8, then the default NPM package manager is buggy, please update it with `npm up -g` command before you proceed.
21+
Please use Node.JS 10+.
2222

2323
(Maybe later, optional) If you're going to change images, please install [GraphicsMagick](http://www.graphicsmagick.org/).
2424

@@ -30,7 +30,7 @@ You can use it to run the tutorial locally and translate it into your language.
3030
3131
3. Create the root folder.
3232
33-
Create a folder `/js` for the project. You can use any other directory as well, just adjust the paths below.
33+
Create a folder `/js` for the project. If you use another directory as the root, adjust the paths below.
3434
3535
4. Clone the tutorial server into it:
3636
@@ -44,7 +44,7 @@ You can use it to run the tutorial locally and translate it into your language.
4444
4545
5. Clone the tutorial text into it.
4646
47-
The text repository has `"-language"` postfix at the end, e.g for the French version `fr`, for Russian – `ru` etc.
47+
The text repository ends with the language code, e.g for the French version `...-fr`, for Russian – `...-ru` etc.
4848
4949
E.g. for the Russian version:
5050
```
@@ -75,7 +75,7 @@ You can use it to run the tutorial locally and translate it into your language.
7575
7676
# Change server language
7777
78-
The server uses English by default for navigation and other non-tutorial messages.
78+
The server uses English by default for navigation and design.
7979
8080
You can set another language it with the second argument of `edit`.
8181
@@ -86,32 +86,31 @@ cd /js/javascript-tutorial-server
8686
./edit ru ru
8787
```
8888
89-
Please note, the server must support that language. That is: server code must have corresponding locale files for that language, otherwise it exists with an error. As of now, `ru` and `en` are fully supported.
89+
Please note, the server must support that language. There must be corresponding locale files for that language in the code of the server, otherwise it exists with an error. As of now, `ru`, `en`, `zh` and `ja` are fully supported.
9090
9191
# Dev mode
9292
93-
If you'd like to edit the server code, *not* the tutorial text (assuming you're familiar with Node.js), then there are two steps.
93+
If you'd like to edit the server code, *not* the tutorial text (assuming you're familiar with Node.js), then there are two steps to make that easy.
9494
9595
First, run the command that imports (and caches) the tutorial:
9696
9797
```
98-
// NODE_LANG sets server language
99-
// TUTORIAL_ROOT is the full path to tutorial repo, by default is /js/javascript-tutorial-$NODE_LANG
100-
10198
cd /js/javascript-tutorial-server
10299
NODE_LANG=en TUTORIAL_ROOT=/js/javascript-tutorial-ru npm run gulp jsengine:koa:tutorial:import
103100
```
104-
105-
And then `./dev <server language>` runs the server:
101+
102+
In the code above, `NODE_LANG` sets server language, while `TUTORIAL_ROOT` is the full path to tutorial repo, by default is `/js/javascript-tutorial-$NODE_LANG`.
103+
104+
Afterwards, call `./dev <server language>` to run the server:
106105
107106
```
108107
cd /js/javascript-tutorial-server
109108
./dev en
110109
```
111110
112-
Running `./dev` uses the tutorial imported and cached by the previous command.
111+
Running `./dev` uses the tutorial that was imported and cached by the previous command.
113112
114-
It does not watch tutorial text, but it reloads the server after code changes.
113+
It does not "watch" tutorial text, but it reloads the server after code changes.
115114
116115
Again, that's for developing the server code itself, not writing the tutorial.
117116

0 commit comments

Comments
 (0)