Skip to content

Commit 4f595be

Browse files
committed
Add note on translation to readme file
1 parent f9b39d0 commit 4f595be

File tree

1 file changed

+38
-1
lines changed

1 file changed

+38
-1
lines changed

README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,47 @@ Feedback welcome, in the form of issues and pull requests.
77

88
## Building
99

10+
This builds the HTML output in `html/`, where `make` is GNU make:
11+
1012
npm install
1113
make html
1214

13-
To build the PDF file:
15+
To build the PDF file (don't bother trying this unless you really need
16+
it, since this list has probably bitrotted again and getting all this
17+
set up is a pain):
1418

1519
apt-get install texlive texlive-xetex fonts-inconsolata fonts-symbola texlive-lang-chinese inkscape
1620
make book.pdf
21+
22+
## Translating
23+
24+
Translations are very much welcome. The license this book is published
25+
under allows non-commercial derivations, which includes open
26+
translations. If you do one, let me know, and I'll add a link to the
27+
website.
28+
29+
A note of caution though: This text consists of about 130 000 words,
30+
the paper book is 400 pages. That's a lot of text, which will take a
31+
lot of time to translate.
32+
33+
If that doesn't scare you off, the recommended way to go about a
34+
translation is:
35+
36+
- Fork this repository on GitHub.
37+
38+
- Create an issue on the repository describing your plan to translate.
39+
40+
- Translate the `.md` files in your fork. These are
41+
[CommonMark](https://commonmark.org/) formatted, with a few
42+
extensions. You may consider omitting the index terms (indicated
43+
with double parentheses and `{{index ...}}` syntax) from your
44+
translation, since that's mostly relevant for print output.
45+
46+
- Publish somewhere online or ask me to host the result.
47+
48+
Doing this in public, and creating an issue that links to your work,
49+
helps avoid wasted effort, where multiple people start a translation
50+
to the same language (and possibly never finish it). (Since
51+
translations have to retain the license, it is okay to pick up someone
52+
else's translation and continue it, even when they have vanished from
53+
the internet.)

0 commit comments

Comments
 (0)