Download as
Browse Code »

Commit 70a3c04259e5db10322e3d5ff7cb89af0fdd1f7d

Authored by Aurélio A. Heckert
1 parent 51bb915e
Exists in master and in 29 other branches add_member_task_reject_details, admin_visible_profile, article-list-template, community_notifications, contact_admin_translation, event_fixes, fix_comments_pagination, fix_rails4_organization_ratings, fix_sign_up_form, follow_step_fix, forum_topic_creation, mirror_block_improvements, multi_env_on_remote_user, new_security, noosfero_spb_ci, organization_ratings_improvements, organization_ratings_link_to_profile_stable-spb-1.3, organization_ratings_translations_fix, profile_api_improvements, ratings_minor_fixes, remote_user_fix, send_email_to_admins, stable-spb-1.3, stable-spb-1.3-fixes, stable-spb-1.4, stable-spb-1.5, suggest_rejected_value, web_steps_improvements, xss_terminate_custom_options

correct HACKING.md markdown

Showing 1 changed file with 22 additions and 29 deletions   Show diff stats
HACKING.md
  Diff comments   View file @70a3c04
1   -= Noosfero instructions for developers
  1 +Noosfero instructions for developers
  2 +====================================
2 3  
3   -== A work about your the development platform
  4 +A work about your the development platform
  5 +------------------------------------------
4 6  
5   -These instructions are tested and known to work on Debian stable, which is the
6   -system that the Noosfero core developers use to work on Noosfero.
  7 +These instructions are tested and known to work on Debian stable, which is the system that the Noosfero core developers use to work on Noosfero.
7 8  
8 9 If you want to use another OS, read "Instructions for other systems" below.
9 10  
10   -== Instructions for Debian stable
  11 +Instructions for Debian stable
  12 +------------------------------
11 13  
12 14 Download the source code:
13 15  
14   - $ git clone git://gitorious.org/noosfero/noosfero.git
15   - $ cd noosfero
  16 + $ git clone git://gitorious.org/noosfero/noosfero.git
  17 + $ cd noosfero
16 18  
17 19 Run the quick start script:
18 20  
19   - $ ./script/quick-start
  21 + $ ./script/quick-start
20 22  
21 23 Now you can execute the development server with:
22 24  
23   - $ ./script/development
  25 + $ ./script/development
24 26  
25 27 You will be able to access Noosfero at http://localhost:3000/
26 28  
27   -If you want to use a different port than 3000, pass `-p <PORT>` to
28   -./script/development
  29 +If you want to use a different port than 3000, pass `-p <PORT>` to `./script/development`
29 30  
30   -== Instructions for other systems
  31 +Instructions for other systems
  32 +------------------------------
31 33  
32 34 On other OS, you have 2 options:
33 35  
34   -1) using a chroot or a VM with Debian stable (easier)
  36 +### 1) using a chroot or a VM with Debian stable (easier)
35 37  
36   -Use a chroot (http://wiki.debian.org/Schroot) or a Virtual Machine (e.g. with
37   -VirtualBox) with a Debian stable system and follow the instructions above for
38   -Debian stable.
  38 +Use a chroot (http://wiki.debian.org/Schroot) or a Virtual Machine (e.g. with VirtualBox) with a Debian stable system and follow the instructions above for Debian stable.
39 39  
40   -2) Installing dependencies on other OS (harder)
  40 +### 2) Installing dependencies on other OS (harder)
41 41  
42   -If you want to setup a development environment in another OS, you can create a
43   -file under script/install-dependencies/, called <OS>-<CODENAME>.sh, which
44   -installed the dependencies for your system. With this script in place,
45   -./script/quick-start will call it at the point of installing the required
46   -packages for Noosfero development.
  42 +If you want to setup a development environment in another OS, you can create a file under `./script/install-dependencies/`, called `<OS>-<CODENAME>.sh`, which installed the dependencies for your system. With this script in place, `./script/quick-start` will call it at the point of installing the required packages for Noosfero development.
47 43  
48   -You can check script/install-dependencies/debian-squeeze.sh to have an idea of
49   -what kind of stuff that script has to do.
  44 +You can check `./script/install-dependencies/debian-squeeze.sh` to have an idea of what kind of stuff that script has to do.
50 45  
51   -If you write such script for your own OS, *please* share it with us at the
52   -development mailing list so that we can include it in the official repository.
53   -This way other people using the same OS will have to put less effort to develop
54   -Noosfero.
  46 +If you write such script for your own OS, *please* share it with us at the development mailing list so that we can include it in the official repository. This way other people using the same OS will have to put less effort to develop Noosfero.
55 47  
56   -== Submitting your changes back
  48 +Submitting your changes back
  49 +----------------------------
57 50  
58 51 For now please read:
59 52  
... ...