Browse Source

Update README.md

Hannes Hirzel 9 years ago
parent
commit
67ba4e42bd
1 changed files with 27 additions and 17 deletions
  1. 27 17
      README.md

+ 27 - 17
README.md

@@ -1,11 +1,10 @@
 amber-examples
 ==============
 
-Various amber examples
+This project contains various Amber Smalltalk  examples. Amber may run in a web browser or as a command line program.
 
 
-
-Prerequisites
+Tools needed
 =============
 
 1. A web browser with reasonably good support for HTML5 canvas.
@@ -13,19 +12,22 @@ Prerequisites
 3. [nodejs](http://www.nodejs.org/). This will give you the node package manager `npm` as well.
 4. A global install of the [`amber`](http://amber-lang.net/) [npm](http://npmjs.org/) package
 5. A global install of the [`bower`](http://bower.io/) client side package manager in order to install the dependencies
+6. A global install of the [`gruntjs`](http://gruntjs.com/) task runner which is used as the command line build system 
 
 The `amber` and `bower` packages can be installed with the following command (In some cases you have to call `npm` with `sudo npm`):
 
-    npm install --global amber-cli bower
+    npm install --global amber-cli bower grunt-cli
 
 or the same thing, but less typing:
 
-    npm i -g amber-cli bower
+    npm i -g amber-cli bower grunt-cli
+    
 
 Reference: http://docs.amber-lang.net/js-glossary.html
 
-Getting started
-===============
+
+Setting up amber-examples 
+==========================
 
 Clone the repository 
 
@@ -38,7 +40,13 @@ Get dependencies of this project:
     npm install
     bower install
 
-Afterwards execute the server:
+
+Amber in the browser  
+==========================
+
+Amber runs in the browser and this includes an IDE. 
+
+To have access to this start a small web server:
 
 `amber serve`
 
@@ -46,24 +54,26 @@ and point your browser to
 
 `http://localhost:4000/`
 
-Rebuilding examples using Grunt.js (development mode)
-====================================================
 
-Since Amber 0.10.0 Grunt.js is used as commandline build system.
-To use it with the examples it is first necessary to install all dependencies with
+Amber on the command line 
+====================================================
 
-* install grunt-cli globally if not already present: `npm install -g grunt-cli`
-* `cd amber-examples`
-* `npm install`
 
-Afterwards the examples can be built/recompiled by running the following command in
-the subdirectory of each example:
+Build or recompile a command line example  (e.g. nodejs) by executing 
 
 `grunt`
 
+in the subdirectory.
+
 The subdirectories might contain additional README files which might contain additional information.
 
 
+Notes
+=====
+
+- Since Amber 0.10.0 Grunt.js is used as commandline build system.
+
+
 Status
 ======