Commit 9d29648dcaf01641eb2ac29d80acfa835d549007
1 parent
1db8d7a7
Exists in
master
and in
28 other branches
Updating installation instructions.
Thanks to Nilton Neves for the feedback.
Showing
2 changed files
with
29 additions
and
17 deletions
Show diff stats
HACKING
@@ -5,16 +5,20 @@ Noosfero development. | @@ -5,16 +5,20 @@ Noosfero development. | ||
5 | 5 | ||
6 | == Requirements for development | 6 | == Requirements for development |
7 | 7 | ||
8 | +First, install all requirements listed in INSTALL. After, you need to install | ||
9 | +some packages be able to run Noosfero tests. On Debian GNU/Linux and | ||
10 | +Debian-based systems, you install them with the following command: | ||
11 | + | ||
12 | + # apt-get install libtidy-ruby libhpricot-ruby libmocha-ruby imagemagick | ||
13 | + | ||
14 | +On other systems, they may or may not be available through your regular package | ||
15 | +management system. Below are the links to their homepages. | ||
16 | + | ||
8 | * Mocha: http://mocha.rubyforge.org/ | 17 | * Mocha: http://mocha.rubyforge.org/ |
9 | * Tidy: http://tidy.sourceforge.net/ | 18 | * Tidy: http://tidy.sourceforge.net/ |
10 | * Hpricot: http://github.com/whymirror/hpricot | 19 | * Hpricot: http://github.com/whymirror/hpricot |
11 | * Imagemagick: http://wwwimagemagick.org/ | 20 | * Imagemagick: http://wwwimagemagick.org/ |
12 | 21 | ||
13 | -You must install these packages to be able to run Noosfero tests. On Debian | ||
14 | -GNU/Linux you install them with the following command: | ||
15 | - | ||
16 | - apt-get install libtidy-ruby libhpricot-ruby libmocha-ruby imagemagick | ||
17 | - | ||
18 | == Boostraping a development/test environment | 22 | == Boostraping a development/test environment |
19 | 23 | ||
20 | You can copy and paste the commands below into a terminal (please review the | 24 | You can copy and paste the commands below into a terminal (please review the |
INSTALL
@@ -9,6 +9,15 @@ free to ask questions in the development mailing list. | @@ -9,6 +9,15 @@ free to ask questions in the development mailing list. | ||
9 | 9 | ||
10 | == Requirements | 10 | == Requirements |
11 | 11 | ||
12 | +You need to install some packages Noosfero depends on. On Debian GNU/Linux or | ||
13 | +Debian-based systems, all of these packages are available through the Debian | ||
14 | +archive. You can install them with the following command: | ||
15 | + | ||
16 | + # aptitude install ruby rake libgettext-ruby1.8 libsqlite3-ruby rcov librmagick-ruby libredcloth-ruby libwill-paginate-ruby iso-codes libfeedparser-ruby libferret-ruby libdaemons-ruby mongrel mongrel-cluster tango-icon-theme | ||
17 | + | ||
18 | +On other systems, they may or may not be available through your regular package | ||
19 | +management system. Below are the links to their homepages. | ||
20 | + | ||
12 | * Ruby: http://www.ruby-lang.org/ | 21 | * Ruby: http://www.ruby-lang.org/ |
13 | * Rake: http://rake.rubyforge.org/ | 22 | * Rake: http://rake.rubyforge.org/ |
14 | * Ruby-GetText: http://www.yotabanana.com/hiki/ruby-gettext.html?ruby-gettext (at least version 1.9.0) | 23 | * Ruby-GetText: http://www.yotabanana.com/hiki/ruby-gettext.html?ruby-gettext (at least version 1.9.0) |
@@ -16,7 +25,7 @@ free to ask questions in the development mailing list. | @@ -16,7 +25,7 @@ free to ask questions in the development mailing list. | ||
16 | * rcov: http://eigenclass.org/hiki/rcov | 25 | * rcov: http://eigenclass.org/hiki/rcov |
17 | * Ferret: http://ferret.davebalmain.com/trac | 26 | * Ferret: http://ferret.davebalmain.com/trac |
18 | * RMagick: http://rmagick.rubyforge.org/ | 27 | * RMagick: http://rmagick.rubyforge.org/ |
19 | -* RedCloth: http://whytheluckystiff.net/ruby/redcloth/ | 28 | +* RedCloth: http://redcloth.org/ |
20 | * will_paginate: http://github.com/mislav/will_paginate/wikis | 29 | * will_paginate: http://github.com/mislav/will_paginate/wikis |
21 | * iso-codes: http://pkg-isocodes.alioth.debian.org/ | 30 | * iso-codes: http://pkg-isocodes.alioth.debian.org/ |
22 | * feedparser: http://packages.debian.org/sid/libfeedparser-ruby | 31 | * feedparser: http://packages.debian.org/sid/libfeedparser-ruby |
@@ -24,21 +33,20 @@ free to ask questions in the development mailing list. | @@ -24,21 +33,20 @@ free to ask questions in the development mailing list. | ||
24 | * Mongrel: http://mongrel.rubyforge.org/ | 33 | * Mongrel: http://mongrel.rubyforge.org/ |
25 | * tango-icon-theme: http://tango.freedesktop.org/Tango_Icon_Library | 34 | * tango-icon-theme: http://tango.freedesktop.org/Tango_Icon_Library |
26 | 35 | ||
27 | -On Debian GNU/Linux, all of these packages are available through the Debian | ||
28 | -archive. You can install them with the following command: | ||
29 | - | ||
30 | - # aptitude install ruby rake libgettext-ruby1.8 libsqlite3-ruby rcov librmagick-ruby libredcloth-ruby libwill-paginate-ruby iso-codes libfeedparser-ruby libferret-ruby libdaemons-ruby mongrel mongrel-cluster tango-icon-theme | ||
31 | - | ||
32 | -We do not have specific instructions for other plaforms yet. If you manage to | ||
33 | -install Noosfero successfully, please feel free to contact the Noosfero | ||
34 | -development mailing with the instructions for doing so, and we'll include it | ||
35 | -here. | 36 | +If you manage to install Noosfero successfully, please feel free to contact the |
37 | +Noosfero development mailing with the instructions for doing so, and we'll | ||
38 | +include it here. | ||
36 | 39 | ||
37 | === Setting up a production environment | 40 | === Setting up a production environment |
38 | 41 | ||
42 | +NOTE: these instructions are for seting up a *production* environment. If you | ||
43 | +are going to do Noosfero development, you don't need to do these steps. See the | ||
44 | +HACKING file instead. | ||
45 | + | ||
39 | * install memcached. Study whether you need to raise the ammount of memory it uses for caching, depending on the demand you expect for your site. | 46 | * install memcached. Study whether you need to raise the ammount of memory it uses for caching, depending on the demand you expect for your site. |
40 | -* copy config/ferret_server.yml.dist to config/ferret_server.yml.dist | ||
41 | -* configure the mongrel cluster: `mongrel_rails cluster::configure` | 47 | +* enter the directory where you unpacked noosfero |
48 | +* copy config/ferret_server.yml.dist to config/ferret_server.yml | ||
49 | +* create the mongrel configuration file: `mongrel_rails cluster::configure` | ||
42 | ** then edit config/mongrel_cluster.yml to suit your environment. Make sure your apache configuration matches the mongrel cluster configuration, specially in respect to the ports and numbers of mongrel instances. | 50 | ** then edit config/mongrel_cluster.yml to suit your environment. Make sure your apache configuration matches the mongrel cluster configuration, specially in respect to the ports and numbers of mongrel instances. |
43 | * create needed temporary directories: | 51 | * create needed temporary directories: |
44 | mkdir tmp | 52 | mkdir tmp |