From 7df1673a819418035fc02ac9109dda6f4b9d77dd Mon Sep 17 00:00:00 2001 From: AntonioTerceiro Date: Mon, 10 Sep 2007 22:55:17 +0000 Subject: [PATCH] ActionItem8: preparing documentation --- doc/DEVELOPMENT | 49 ------------------------------------------------- doc/README_FOR_APP | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-- 2 files changed, 54 insertions(+), 51 deletions(-) delete mode 100644 doc/DEVELOPMENT diff --git a/doc/DEVELOPMENT b/doc/DEVELOPMENT deleted file mode 100644 index dc9c003..0000000 --- a/doc/DEVELOPMENT +++ /dev/null @@ -1,49 +0,0 @@ -== Setting up a Noosfero development/test environment - -=== Requirements - -You need to have a Subversion client (svn) installed, as well as: - -* Ruby:http://www.ruby-lang.org/ -* Rake:http://rake.rubyforge.org/ -* Ruby-GetText:http://www.yotabanana.com/hiki/ruby-gettext.html?ruby-gettext -* Mocha:http://mocha.rubyforge.org/ -* Ruby-sqlite3:http://rubyforge.org/projects/sqlite-ruby - -There are Debian packages available for all of them. Try: - - # aptitude install svn ruby rake libgettext-ruby libmocha-ruby libsqlite3-ruby - -If you have problems with the setup, use the development mailing list. In -special its possible that the requirements list above is not complete. - -=== Getting Noosfero source - - $ svn checkout https://svn.colivre.coop.br/svn/noosfero/trunk/ noosfero - $ cd noosfero - $ cp config/database.yml.sqlite3 config/database.yml - $ rake db:migrate - -You should now be ready to go. Issue the following command to start the Rails -development server: - - $ ./script/server - -The server will be available at http://localhost:3000/ . If you want to use -another port than 3000, you can use the -p option of ./script/server: - - & ./script/server -p 9999 - -The above command makes the server available at http://localhost:9999/ - -== Reporting bugs - -Use Noosfero Tracker application at http://www.colivre.coop.br/Noosfero. - -== Helping with development - -* It's recommended that you subscribe to the "development mailing - list":http://ynternet.net/mailman/listinfo/noosfero -* If you have a patch, create an appropriate action item - (bugs/requirement/enhancement) in the Tracker web (see "Reporting bugs" - above) of type. diff --git a/doc/README_FOR_APP b/doc/README_FOR_APP index ac6c149..b4a8799 100644 --- a/doc/README_FOR_APP +++ b/doc/README_FOR_APP @@ -1,2 +1,54 @@ -Use this README file to introduce your application and point to useful places in the API for learning more. -Run "rake appdoc" to generate API documentation for your models and controllers. \ No newline at end of file += Noosfero: a free web-based social platform + +== Setting up a Noosfero development/test environment + +Noosfero is written in Ruby with the "Rails framework":http://www.rubyonrails.org, +so the process of setting it up is pretty similar to other Rails applications. + +=== Requirements + +You need to have a Subversion client (svn) installed, as well as: + +* Ruby:http://www.ruby-lang.org/ +* Rake:http://rake.rubyforge.org/ +* Ruby-GetText:http://www.yotabanana.com/hiki/ruby-gettext.html?ruby-gettext +* Mocha:http://mocha.rubyforge.org/ +* Ruby-sqlite3:http://rubyforge.org/projects/sqlite-ruby + +There are Debian packages available for all of them. Try: + + # aptitude install svn ruby rake libgettext-ruby libmocha-ruby libsqlite3-ruby + +If you have problems with the setup, use the development mailing list. In +special its possible that the requirements list above is not complete. + +=== Getting Noosfero source + + $ svn checkout https://svn.colivre.coop.br/svn/noosfero/trunk/ noosfero + $ cd noosfero + $ cp config/database.yml.sqlite3 config/database.yml + $ rake db:migrate + +You should now be ready to go. Issue the following command to start the Rails +development server: + + $ ./script/server + +The server will be available at http://localhost:3000/ . If you want to use +another port than 3000, you can use the -p option of ./script/server: + + & ./script/server -p 9999 + +The above command makes the server available at http://localhost:9999/ + +== Reporting bugs + +Use Noosfero Tracker application at http://www.colivre.coop.br/Noosfero. + +== Helping with development + +* It's recommended that you subscribe to the "development mailing + list":http://ynternet.net/mailman/listinfo/noosfero +* If you have a patch, create an appropriate action item + (bugs/requirement/enhancement) in the Tracker web (see "Reporting bugs" + above) of type. -- libgit2 0.21.2