Skip to content
Newer
Older
100644 138 lines (87 sloc) 4.05 KB
f924deb @mattetti fixed the readme syntax
mattetti authored Dec 2, 2008
1 # The Merb Open Source Book
ecc5f5d @mattetti added the fundations of the Merb Open Source Book
mattetti authored Dec 1, 2008
2
3e8e176 @mattetti updated the readme
mattetti authored Dec 2, 2008
3 This book is an open source book written for and by the Merb community.
ecc5f5d @mattetti added the fundations of the Merb Open Source Book
mattetti authored Dec 2, 2008
4
2b15f58 @mattetti added guidelines to the README
mattetti authored Dec 8, 2008
5 Preview: <http://book.merbist.com>
6
effc561 @RichMorin mostly, broke lines and tweaked link formats
RichMorin authored Dec 7, 2008
7 To run the book locally,
8 just clone this repo and start the bundled copy of Merb:
3e8e176 @mattetti updated the readme
mattetti authored Dec 2, 2008
9
10 $ ./bin/merb
11
12 And open http://localhost:4000/ in your browser
13
effc561 @RichMorin mostly, broke lines and tweaked link formats
RichMorin authored Dec 8, 2008
14 Note that you might have to "redeploy" the native gems
15 if the <tt>merb</tt> app server doesn't start:
81bca32 @mattetti updated the TOC based on deimos1986 suggestions
mattetti authored Dec 2, 2008
16
2b15f58 @mattetti added guidelines to the README
mattetti authored Dec 8, 2008
17 $ ./bin/thor merb:gem:redeploy
81bca32 @mattetti updated the TOC based on deimos1986 suggestions
mattetti authored Dec 2, 2008
18
3e8e176 @mattetti updated the readme
mattetti authored Dec 2, 2008
19 A static HTML and a PDF version will soon be available online.
20
f924deb @mattetti fixed the readme syntax
mattetti authored Dec 2, 2008
21 ## How to contribute
3e8e176 @mattetti updated the readme
mattetti authored Dec 2, 2008
22
951a0fa @RichMorin Save file and try again :-/
RichMorin authored Dec 11, 2008
23 * Install the github gem
24 from <http://github.com/defunkt/github-gem/tree/master>.
5626375 @RichMorin Add a few missing steps; tweak instruction text.
RichMorin authored Dec 11, 2008
25
26 $ gem install defunkt-github -s http://gems.github.com
27
28 * Fork the mattetti/merb-book project by clicking the fork button
29 at <http://github.com/mattetti/merb-book/tree/master>.
30
31 * Clone a copy of the repository to the local machine.
32
33 $ git clone git@github.com:YOUR_GITHUB_USERNAME/merb-book.git
34
35 * Choosing from the branches in Mattetti’s repo (i.e., ‘english’),
36 select the LANGUAGE you're going to contribute to.
37
951a0fa @RichMorin Save file and try again :-/
RichMorin authored Dec 12, 2008
38 * Enter the `merb-book` directory.
39
40 $ cd merb-book
41
5626375 @RichMorin Add a few missing steps; tweak instruction text.
RichMorin authored Dec 12, 2008
42 * Checkout the remote branch for the LANGUAGE that you're working on.
43
44 $ gh pull mattetti LANGUAGE
45
46 * Checkout a local copy of your language branch.
47
48 $ gh checkout -b LANGUAGE
49
951a0fa @RichMorin Save file and try again :-/
RichMorin authored Dec 12, 2008
50 * Do a sanity check.
51
52 $ git branch
a4fd04d @RichMorin change "english" to "LANGUAGE", for consistency
RichMorin authored Dec 11, 2008
53 * LANGUAGE
951a0fa @RichMorin Save file and try again :-/
RichMorin authored Dec 12, 2008
54 master
a4fd04d @RichMorin change "english" to "LANGUAGE", for consistency
RichMorin authored Dec 12, 2008
55 mattetti/LANGUAGE
951a0fa @RichMorin Save file and try again :-/
RichMorin authored Dec 12, 2008
56
5626375 @RichMorin Add a few missing steps; tweak instruction text.
RichMorin authored Dec 12, 2008
57 * Set up a remote branch on github for your language.
58
59 $ git push origin LANGUAGE
60
61 * Modify, fix, and add content in your local LANGUAGE branch.
951a0fa @RichMorin Save file and try again :-/
RichMorin authored Dec 12, 2008
62
63 * Commit your changes into your local Git repository.
64
65 $ git commit -a
66
5626375 @RichMorin Add a few missing steps; tweak instruction text.
RichMorin authored Dec 12, 2008
67 * Merge in the upstream changes.
68
69 $ gh pull --merge mattetti LANGUAGE
70
71 * Push your changes back to github.
72
73 $ git push
74
75 * Send Mattetti a pull request.
3e8e176 @mattetti updated the readme
mattetti authored Dec 2, 2008
76
effc561 @RichMorin mostly, broke lines and tweaked link formats
RichMorin authored Dec 8, 2008
77 For the moment, the content of the book
78 is located inside <tt>./book-content/</tt>
79 and is organized by languages, chapters, and pages.
3e8e176 @mattetti updated the readme
mattetti authored Dec 2, 2008
80
effc561 @RichMorin mostly, broke lines and tweaked link formats
RichMorin authored Dec 8, 2008
81 Chapters and pages must be lowercase and start by a digit
82 followed by a dash and the chapter/page title
83 without spaces or any non ascii characters.
3e8e176 @mattetti updated the readme
mattetti authored Dec 2, 2008
84
effc561 @RichMorin mostly, broke lines and tweaked link formats
RichMorin authored Dec 8, 2008
85 All content files are Markdown files;
86 the <tt>merb</tt> app uses [maruku][] to render these files.
87 Check the [supported syntax][]
88 or check ./book-content/en/1-introduction/1-ruby.markdown
89 for a good example of how to use images, quotes, and CSS selectors.
331383c @mattetti added i18n to the merb book
mattetti authored Dec 2, 2008
90
effc561 @RichMorin mostly, broke lines and tweaked link formats
RichMorin authored Dec 8, 2008
91 The book supports multiple languages.
92 Each language needs to replicate the English folder structure,
93 using the *same* file names.
331383c @mattetti added i18n to the merb book
mattetti authored Dec 2, 2008
94
effc561 @RichMorin mostly, broke lines and tweaked link formats
RichMorin authored Dec 8, 2008
95 If you are copying a page or chapter to your language folder
96 and want to mark a section of your text as requiring translation,
97 just add the <tt>to-translate</tt> class
98 to the CSS selector of your content, as shown below:
331383c @mattetti added i18n to the merb book
mattetti authored Dec 2, 2008
99
2b15f58 @mattetti added guidelines to the README
mattetti authored Dec 8, 2008
100 {: .to-translate}
101
102 Please follow our editor guidelines, especially:
103
104 * use a language branch (so you can see what changed in the English content)
105 * one sentence per line (so merging is easier)
106
107 <http://groups.google.com/group/merb-book/web/guidelines>
ecc5f5d @mattetti added the fundations of the Merb Open Source Book
mattetti authored Dec 2, 2008
108
0858a8d @mattetti added translation leaders
mattetti authored Dec 5, 2008
109 ## Translation leaders
110
effc561 @RichMorin mostly, broke lines and tweaked link formats
RichMorin authored Dec 8, 2008
111 * Bosnian: http://github.com/sidonath (Damir Zekić)
112 * Chinese: http://github.com/zhhz (Zhonghai Zuo)
113 * French: http://github.com/pointcom (Mathieu Fosse)
114 * German: http://github.com/cypher (Markus Prinz)
c744502 @mattetti added carlopecchia as leader for the Italian translation
mattetti authored Dec 8, 2008
115 * Italian: http://github.com/carlopecchia (Carlo Pecchia)
effc561 @RichMorin mostly, broke lines and tweaked link formats
RichMorin authored Dec 8, 2008
116 * Japanese: http://github.com/kwatch (Makoto Kuwata)
117 * Portuguese: http://github.com/akitaonrails (Fabio Akita)
118 * Russian: http://github.com/cheba (Alex Mankuta)
a8daac1 @mattetti made Joaquin the official Spanish translation líder ;)
mattetti authored Dec 15, 2008
119 * Spanish: http://github.com/joahking (Joaquin Rivera Padron)
700056d @mattetti added Dutch translation leader: Peter De Velder
mattetti authored Dec 7, 2008
120 * Dutch: http://github.com/pvelder (Peter De Velder)
ad33ef5 @mattetti Added khelll as lead of the Arabic translation team
mattetti authored Dec 8, 2008
121 * Arabic http://github.com/khelll (Khaled AlHabache)
a8daac1 @mattetti made Joaquin the official Spanish translation líder ;)
mattetti authored Dec 15, 2008
122 * Indonesian (pending)
ecc5f5d @mattetti added the fundations of the Merb Open Source Book
mattetti authored Dec 2, 2008
123
f924deb @mattetti fixed the readme syntax
mattetti authored Dec 2, 2008
124 ## Legal
ecc5f5d @mattetti added the fundations of the Merb Open Source Book
mattetti authored Dec 2, 2008
125
effc561 @RichMorin mostly, broke lines and tweaked link formats
RichMorin authored Dec 8, 2008
126 The content of this book is licensed under the [Creative Commons Attribution-Noncommercial-Share Alike 3.0 license][]
ecc5f5d @mattetti added the fundations of the Merb Open Source Book
mattetti authored Dec 2, 2008
127
effc561 @RichMorin mostly, broke lines and tweaked link formats
RichMorin authored Dec 8, 2008
128 The source code of the application is dual licensed
129 under the MIT and GPL licenses:
ecc5f5d @mattetti added the fundations of the Merb Open Source Book
mattetti authored Dec 2, 2008
130
3e8e176 @mattetti updated the readme
mattetti authored Dec 2, 2008
131 * [MIT](http://www.opensource.org/licenses/mit-license.php)
132 * [GPL](http://www.gnu.org/licenses/gpl.html)
effc561 @RichMorin mostly, broke lines and tweaked link formats
RichMorin authored Dec 8, 2008
133
134
135 [Creative Commons Attribution-Noncommercial-Share Alike 3.0 license]: http://creativecommons.org/licenses/by-nc-sa/3.0/us/
136 [maruku]: http://maruku.rubyforge.org
137 [supported syntax]: http://maruku.rubyforge.org/markdown_syntax.html
Something went wrong with that request. Please try again.