Skip to content

Commit 9d45b96

Browse files
authored
Update README.md
1 parent 03b1ceb commit 9d45b96

File tree

1 file changed

+19
-18
lines changed

1 file changed

+19
-18
lines changed

README.md

+19-18
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Tutorial server
1+
# Tutorial Server
22

33
Hi everyone!
44

@@ -10,12 +10,12 @@ Windows, Unix-systems and MacOS are supported. For Windows, you'll need to call
1010

1111
# Installation
1212

13-
1. Install [Git](https://git-scm.com/downloads) and [Node.JS](https://nodejs.org).
13+
1. Install [Git](https://git-scm.com/downloads) and [Node.js](https://nodejs.org).
1414

1515
These are required to update and run the project.
1616
For Windows just download and install, otherwise use standard OS install tools (packages or whatever convenient).
1717

18-
Please use Node.JS 10+.
18+
Please use Node.js 10+.
1919

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

@@ -33,28 +33,29 @@ Windows, Unix-systems and MacOS are supported. For Windows, you'll need to call
3333
3434
```
3535
cd /js
36-
git clone https://github.com/iliakan/javascript-tutorial-server
37-
git clone https://github.com/iliakan/jsengine javascript-tutorial-server/modules/jsengine
36+
git clone https://github.com/javascript-tutorial/server
37+
git clone https://github.com/javascript-tutorial/engine server/modules/engine
3838
```
3939
40-
Please note, there are two clone commands. That's not a typo: `modules/jsengine` is cloned from another repository.
40+
Please note, there are two clone commands. That's not a typo: `modules/engine` is cloned from another repository.
4141
4242
5. Clone the tutorial text into it.
4343
44-
The text repository ends with the language code, e.g for the French version `...-fr`, for Russian – `...-ru` etc.
45-
46-
E.g. for the English version:
44+
The repository starts with the language code, e.g for the French version `fr.javascript.info`, for Russian – `ru.javascript.info` etc.
45+
46+
The English version is `en.javascript.info`.
47+
4748
```
4849
cd /js
49-
git clone https://github.com/iliakan/javascript-tutorial-en
50+
git clone https://github.com/iliakan/en.javascript.info
5051
```
5152
5253
6. Run the site
5354
5455
Install local modules:
5556
5657
```
57-
cd /js/javascript-tutorial-server
58+
cd /js/server
5859
npm install
5960
```
6061
@@ -64,7 +65,7 @@ Windows, Unix-systems and MacOS are supported. For Windows, you'll need to call
6465
./edit en
6566
```
6667
67-
This will import the tutorial from `/js/javascript-tutorial-en` and start the server.
68+
This will import the tutorial from `/js/en.javascript.info` and start the server.
6869
6970
Wait a bit while it reads the tutorial from the disk and builds static assets.
7071
@@ -85,7 +86,7 @@ You can set another language it with the second argument of `edit`.
8586
E.g. if you cloned `ru` tutorial, it makes sense to use `ru` locale for the server as well:
8687
8788
```
88-
cd /js/javascript-tutorial-server
89+
cd /js/server
8990
./edit ru ru
9091
```
9192
@@ -98,16 +99,16 @@ If you'd like to edit the server code (assuming you're familiar with Node.js), *
9899
First, run the command that imports (and caches) the tutorial:
99100
100101
```
101-
cd /js/javascript-tutorial-server
102-
NODE_LANG=en TUTORIAL_ROOT=/js/javascript-tutorial-en npm run gulp jsengine:koa:tutorial:import
102+
cd /js/server
103+
NODE_LANG=en TUTORIAL_ROOT=/js/en.javascript.info npm run gulp engine:koa:tutorial:import
103104
```
104105
105-
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`.
106+
In the code above, `NODE_LANG` sets server language, while `TUTORIAL_ROOT` is the full path to tutorial repo, by default is `/js/$NODE_LANG.javascript.info`.
106107
107108
Afterwards, call `./dev <server language>` to run the server:
108109
109110
```
110-
cd /js/javascript-tutorial-server
111+
cd /js/server
111112
./dev en
112113
```
113114
@@ -123,7 +124,7 @@ If you have a very old copy of the English tutorial, please rename `1-js/05-data
123124
124125
Please ensure you have Node.js version 10+ (`node -v` shows the version).
125126
126-
If it still doesn't work – [file an issue](https://github.com/iliakan/javascript-tutorial-server/issues/new). Please mention OS and Node.js version,
127+
If it still doesn't work – [file an issue](https://github.com/javascript-tutorial/server/issues/new). Please mention OS and Node.js version,
127128
128129
Please pull the very latest git code and install latest NPM modules before publishing an issue.
129130

0 commit comments

Comments
 (0)