forked from iliakan/javascript-book
-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.html
81 lines (48 loc) · 3.69 KB
/
readme.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
<!DOCTYPE HTML>
<html>
<body style="width:700px;margin:auto;font-family: Georgia, Arial, sans-serif">
<h2>Welcome!</h2>
<p>Hey hey hey! Welcome to the offline editable release of the tutorial!</p>
<p>You can study it on Cook islands being completely out of the net, and everything would work. You can edit it and push updates which get merged in.</p>
<p>To start browsing, go to the language folder and open <code>nav.html</code>.</p>
<h2>TroubleShooting</h2>
For Chrome/Chromium: run the browser with the flag <code>--allow-file-access-from-files</code>.
For other issues and suggestions, use Github at <a href="https://github.com/iliakan/javascript-book/">https://github.com/iliakan/javascript-book/</a>.
<h2>Contribution</h2>
<p>Help us to create a really great JavaScript book!</p>
You are welcome to:
<ul>
<li>Fix typos.</li>
<li>Translate the book.</li>
<li>Rephrase and improve the text, make it better.</li>
<li>Change styles, improve look and feel.</li>
<li>Add your chapters.</li>
</ul>
<p>The contributions are carefully reviewed and appended or integrated with the current content.</p>
<p>All changes are done offline. This way is chosen, because it gives full freedom.</p>
You can add images, HTML/JS/CSS examples and manage the text in your favorite editor.
<p>The formatting of the text is HTML-compatible, with many features borrowed from Markdown. There are additional, powerful abilities for interactive JS and HTML/CSS. Read about it in <a href="about/format.html">about/format.html</a>.</p>
<h3>Translation</h3>
<p>If you want to translate, please create an issue at <a href="https://github.com/iliakan/javascript-book/issues/new">https://github.com/iliakan/javascript-book/issues/new</a> (need to register at Github) announcing what you are going to translate. Something like "translating chapter xx".</p>
<p>This should help to evade conflicts when someone else is translating the same.</p>
<h3>Sending changes</h3>
<p>First, if you contribute something entirely new, like translation or a new chapter, you can just send it in the way you like. See the email below.</p>
<p>If you know Git, then create a pull request for <a href="https://github.com/iliakan/javascript-book">https://github.com/iliakan/javascript-book</a>. That's the best.</p>
<p>If you don't know Git... Things are still easy. You can install it and use in 5 minutes.</p>
<ol>
<li>Grab it from <a href="http://git-scm.com/">http://git-scm.com/</a>, install.</li>
<li>Run <code>git clone git://github.com/iliakan/javascript-book.git jsbook</code>, that creates <code>jsbook</code> folder with the book.</li>
<li>Edit the book in that folder.</li>
<li>To summarize changes, run <code>git diff >my.diff</code> in the folder. It saves all changes in the file <code>my.diff</code>.</li>
<li>Send it on the email <a href="mailto:[email protected]">[email protected]</a>. Now they will get merged in. </li>
</ol>
<p>Actually, Git is much more powerful than that. But there are more thorough books and manuals about it ;).</p>
<p>By sending out your contribution, you agree to the terms of the <a href="http://creativecommons.org/publicdomain/zero/1.0/deed">CC0</a> license. In short, you provide no warranty of any kind and put it to the public domain. If you want to contribute a large part under another license - let us know.</p>
<p>Thank you.</p>
<h2>Contacts</h2>
<p>The right place to ask questions and raise discussions is Github: <a href="https://github.com/iliakan/javascript-book/">https://github.com/iliakan/javascript-book/</a>.</p>
<hr>
<p>The framework and the book content are available under the terms of <a href="http://creativecommons.org/licenses/by-nc-sa/3.0/deed">CC BY-NC-SA</a>.</p>
<i>Ilya Kantor, 2011.</i>
</body>
</html>