| | |
| 2 | 2 | |
| 3 | 3 | === Dependencies |
| 4 | 4 | |
| 5 | Ruby libraries/bindings/gems |
| 6 | |
| 5 | 7 | * BlueCloth (http://rubyforge.org/projects/bluecloth/) |
| 6 | 8 | * mime-types (http://rubyforge.org/projects/mime-types) |
| 7 | 9 | * oniguruma (http://rubyforge.org/projects/oniguruma) |
| 8 | | ** requires the oniguruma C library: (http://www.geocities.jp/kosako3/oniguruma/) |
| 9 | 10 | * textpow (http://rubyforge.org/projects/textpow) |
| 10 | | * chronic |
| 11 | | * rmagick |
| 11 | * chronic (http://rubyforge.org/projects/chronic) |
| 12 | * rmagick (http://rubyforge.org/projects/rmagick) |
| 13 | |
| 14 | Libraries/applications: |
| 15 | |
| 16 | * Git (http://git-scm.org) |
| 17 | * Oniguruma C library (http://www.geocities.jp/kosako3/oniguruma/) |
| 18 | * Sphinx (http://sphinxsearch.com/) |
| 19 | |
| 20 | (App is deployed on mysql, allthough source should be free of mysql-isms/quirks) |
| 21 | |
| 12 | 22 | |
| 13 | 23 | === The Hackers digest guide: |
| 14 | 24 | |
| … | … | |
| 34 | 34 | |
| 35 | 35 | Consult the mailinglist (http://groups.google.com/group/gitorious) or drop in |
| 36 | 36 | by #gitorious on irc.freenode.net if you have questions. |
| 37 | |
| 38 | |
| 39 | === Tasks and other scripts |
| 40 | |
| 41 | * script/task_performer runs any tasks in the queue (creating repositories etc) |
| 42 | * script/graph_generator generates graph. |
| 43 | * rake ultrasphinx:index runs the search indexer |
| 44 | |
| 45 | |
| 46 | === Coding style |
| 47 | |
| 48 | * Two spaces, no tabs, for indention |
| 49 | * Don't use and and or for boolean tests, instead always use && and || |
| 50 | * MyClass.my_method(my_arg) -- not my_method( my_arg ) or my_method my_arg |
| 51 | * Unless presedence is an issue; do .. end for multi-line blocks, braces for single line blocks |
| 52 | * Follow the conventions you see used in the source already |
| 53 | |
| 54 | (copied mostly verbatim from dev.rubyonrails.org) |
| 55 | |
| toggle raw diff |
--- a/HACKING
+++ b/HACKING
@@ -2,13 +2,23 @@
=== Dependencies
+Ruby libraries/bindings/gems
+
* BlueCloth (http://rubyforge.org/projects/bluecloth/)
* mime-types (http://rubyforge.org/projects/mime-types)
* oniguruma (http://rubyforge.org/projects/oniguruma)
-** requires the oniguruma C library: (http://www.geocities.jp/kosako3/oniguruma/)
* textpow (http://rubyforge.org/projects/textpow)
-* chronic
-* rmagick
+* chronic (http://rubyforge.org/projects/chronic)
+* rmagick (http://rubyforge.org/projects/rmagick)
+
+Libraries/applications:
+
+* Git (http://git-scm.org)
+* Oniguruma C library (http://www.geocities.jp/kosako3/oniguruma/)
+* Sphinx (http://sphinxsearch.com/)
+
+(App is deployed on mysql, allthough source should be free of mysql-isms/quirks)
+
=== The Hackers digest guide:
@@ -24,3 +34,22 @@
Consult the mailinglist (http://groups.google.com/group/gitorious) or drop in
by #gitorious on irc.freenode.net if you have questions.
+
+
+=== Tasks and other scripts
+
+* script/task_performer runs any tasks in the queue (creating repositories etc)
+* script/graph_generator generates graph.
+* rake ultrasphinx:index runs the search indexer
+
+
+=== Coding style
+
+* Two spaces, no tabs, for indention
+* Don't use and and or for boolean tests, instead always use && and ||
+* MyClass.my_method(my_arg) -- not my_method( my_arg ) or my_method my_arg
+* Unless presedence is an issue; do .. end for multi-line blocks, braces for single line blocks
+* Follow the conventions you see used in the source already
+
+(copied mostly verbatim from dev.rubyonrails.org)
+ |
