Skip to content

Commit 74a74c5

Browse files
committed
readme
1 parent 7f5cfce commit 74a74c5

File tree

1 file changed

+6
-40
lines changed

1 file changed

+6
-40
lines changed

README.md

Lines changed: 6 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,6 @@
11
# The Modern JavaScript Tutorial in German
22

3-
<<<<<<< HEAD
4-
<<<<<<< HEAD
53
This repository hosts the translation of <https://javascript.info> in German.
6-
=======
7-
This repository hosts the English content of the Modern JavaScript Tutorial, published in [https://javascript.info](https://javascript.info).
8-
>>>>>>> a82915575863d33db6b892087975f84dea6cb425
9-
=======
10-
This repository hosts the English content of the Modern JavaScript Tutorial, published at [https://javascript.info](https://javascript.info).
11-
>>>>>>> d694e895efe89922a109702085b6ca1efeffea10
124

135

146
**That's how you can contribute:**
@@ -29,33 +21,15 @@ If maintainers do not respond, or if you'd like to become a maintainer, write us
2921

3022
🎉 Thank you!
3123

32-
<<<<<<< HEAD
3324
Your name and the contribution size will appear in the "About project" page when the translation gets published.
3425

35-
<<<<<<< HEAD
3626
P.S. The full list of languages can be found at <https://javascript.info/translate>.
37-
=======
38-
**You can edit the text in any editor.** The tutorial uses enhanced "markdown" format, easy to grasp. And if you want to see how it looks on-site, there's a server to run the tutorial locally at <https://github.com/javascript-tutorial/server>.
39-
=======
40-
Something's wrong? A topic is missing? Explain it to people, add it as PR 👏
41-
42-
**You can edit the text in any editor.** The tutorial uses an enhanced "markdown" format, easy to grasp. And if you want to see how it looks on-site, there's a server to run the tutorial locally at <https://github.com/javascript-tutorial/server>.
43-
>>>>>>> d694e895efe89922a109702085b6ca1efeffea10
44-
45-
The list of contributors is available at <https://javascript.info/about#contributors>.
46-
>>>>>>> a82915575863d33db6b892087975f84dea6cb425
4727

4828
## Structure
4929

50-
<<<<<<< HEAD
5130
Every chapter, an article or a task resides in its own folder.
5231

5332
The folder is named `N-url`, where `N` – is the number for sorting (articles are ordered), and `url` is the URL-slug on the site.
54-
=======
55-
Every chapter, article, or task has its folder.
56-
57-
The folder is named like `N-url`, where `N` is a number for the sorting purposes and `URL` is the URL part with the title of the material.
58-
>>>>>>> d694e895efe89922a109702085b6ca1efeffea10
5933

6034
The folder has one of files:
6135

@@ -86,11 +60,15 @@ In English many terms have an obvious meaning. For a person who doesn't understa
8660
Please keep that in mind, sometimes explanations or additional translations are needed, e.g.
8761

8862
```md
89-
`ReadableStream` objects allows to read data chunk-by-chunk.
63+
`ReadableStream` allows to read data chunk-by-chunk.
9064
```
9165

66+
The class name `ReadableStream` has an obvious meaning for those who understand English.
67+
68+
Some people who read translations may not know English so well. So we can add a translation of `ReadableStream` in parentheses, like this (Spanish below):
69+
9270
```md
93-
`ReadableStream` ("flujo legible") objeto ...
71+
`ReadableStream` ("flujo legible") permite leer datos fragmento por fragmento.
9472
```
9573

9674
### Text in Code Blocks
@@ -128,13 +106,7 @@ document.querySelector('.hola').innerHTML = text;
128106

129107
Please note, that sometimes code is followed by pictures, and if you translate text `Hello` -> `Hola` in the code, you need to translate text in picturess as well.
130108

131-
<<<<<<< HEAD
132109
In that case it's probably easier not to translate such text. See more about translating images later.
133-
=======
134-
- `index.md` stands for a chapter
135-
- `article.md` stands for an article
136-
- `task.md` stands for a task (solution must be provided in `solution.md` file as well)
137-
>>>>>>> a82915575863d33db6b892087975f84dea6cb425
138110

139111

140112
### External Links
@@ -164,7 +136,6 @@ Some files, usually tasks, have YAML metadata at the top, delimited by `---`:
164136
```md
165137
importance: 5
166138

167-
<<<<<<< HEAD
168139
---
169140
...
170141
```
@@ -201,8 +172,3 @@ image.svg: # image file
201172
You can run the tutorial server locally to see how the translation looks.
202173
203174
The server and install instructions are at <https://github.com/javascript-tutorial/server>.
204-
=======
205-
---
206-
207-
Ilya Kantor @iliakan
208-
>>>>>>> a82915575863d33db6b892087975f84dea6cb425

0 commit comments

Comments
 (0)