Browse Source

restructure README file

Manfred Kroehnert 9 years ago
parent
commit
1295a9c30c
1 changed files with 31 additions and 10 deletions
  1. 31 10
      README.md

+ 31 - 10
README.md

@@ -6,17 +6,38 @@ Helios IDE for Amber Smalltalk
 How to contribute
 How to contribute
 ====
 ====
 
 
-There are two ways how to contribute. In both way you need to fork this repo first.
+Prerequisites
+===
 
 
-First way is by cloning your fork and setting it up (have `node` and `npm` installed,
-have `bower`, `grunt-cli` and `amber-cli` npm packages installed globally,
-then run `npm install`, `bower install` and `grunt devel` in the project directory,
-after what you can go the classical Amber project way of running `amber serve` from CLI
-and go to `http://localhost:4000/` in the browser). This way you can only contribute
-to Helios itself.
+The following packages need to be installed globally:
+
+* `node` (NodeJS)
+* `npm` (NodeJS package manager)
+* `bower` (JavaScript package manager)
+* `grunt-cli` (build packages on the commandline)
+* `amber-cli` (for serving and creating Amber applications)
+
+Helios development setup
+===
+
+There are two ways how to contribute. Both ways require forking this repo first and fetching all required packages via NPM and Bower.
+
+# `git clone https://github.com/amber-smalltalk/helios.git`
+# `cd helios`
+# `npm install`
+# `bower install`
+# `grunt devel`
+
+If you only want to contribute to Helios itself you can now run Helios as a regular Amber application by executing
+
+* `amber serve`
+
+and visiting `http://localhost:4000/` in the browser.
 
 
 As Helios is still coupled with Amber, you need occasionally make change to Amber itself,
 As Helios is still coupled with Amber, you need occasionally make change to Amber itself,
-not just to Helios code. Thus, recommended way is to fork and clone Amber repository itself
-for development (see https://github.com/amber-smalltalk/amber/blob/master/CONTRIBUTING.md,
+not just to Helios code.
+The recommended way is to fork and clone Amber repository itself for development
+(see https://github.com/amber-smalltalk/amber/blob/master/CONTRIBUTING.md,
 "Setup your Amber clone" part and use your own fork in the "clone Helios" step).
 "Setup your Amber clone" part and use your own fork in the "clone Helios" step).
-This allows you to develop Amber itself, `amber-cli` and Helios at once.
+This allows you to develop Amber itself, `amber-cli` and Helios simultaneously.
+