Browse Source

Update README.

Herbert Vojčík 8 years ago
parent
commit
92a789b862
1 changed files with 20 additions and 32 deletions
  1. 20 32
      README.md

+ 20 - 32
README.md

@@ -11,19 +11,7 @@ By Nicolas Petton <petton.nicolas@gmail.com> and [Amber contributors](https://gi
 
 Amber is an implementation of the Smalltalk language that runs on top of the JavaScript runtime. It is designed to make client-side development faster and easier.
 
-> \o/ **Call for contributors!**  \o/
->
-> The core project of Amber has enough resources, but:
-> - the Helios IDE (https://github.com/amber-smalltalk/helios), as well as
-> - examples (https://github.com/amber-smalltalk/amber-examples), and
-> - documentation (https://github.com/amber-smalltalk/amber-documentation)
->
-> would need some of your care.
->
-> Thank you very much!
->
-> (see [CONTRIBUTING.md](CONTRIBUTING.md) for further details)
-
+Try Amber online and learn more on [project page](http://amber-lang.net).
 
 Overview
 --------
@@ -32,20 +20,28 @@ Amber is written in itself, including the parser and compiler. Amber compiles in
 
 Some highlights:
 
--    Amber features an IDE with a Class browser, Workspace, Transcript, a ReferencesBrowser supporting senders/implementors and class references, basic Inspector and even a beginning of a Debugger and a unit TestRunner.
--    [Pharo Smalltalk](http://www.pharo-project.org) is considered as the reference implementation.
--    Amber includes a canvas to generate HTML, like [Seaside](http://www.seaside.st)
--    Amber can use Javascript libraries and the current IDE is built on [jQuery](http://www.jquery.com)
--    You can inline Javascript code and there are many ways to interact between Amber and Javascript
+- Amber features an IDE with a Class browser, Workspace, Transcript, a ReferencesBrowser supporting senders/implementors and class references, basic Inspector and even a beginning of a Debugger and a unit TestRunner.
+- [Pharo Smalltalk](http://www.pharo-project.org) is considered as the reference implementation.
+- Amber is extendable with libraries, installable preferably via `bower`:
+    - `amber-contrib-web` with a canvas to generate HTML, like [Seaside](http://www.seaside.st), included in a new project by default,
+    - `silk` with a stream-like wrapping of DOM elements, included in a new project by default,
+    - `helios` IDE, included in a new project by default,
+    - `amber-contrib-legacy` with smaller in-page "classic" IDE and some miscellany, included in a new project by default,
+    - `trysmalltalk`, containing [Prof Stef](http://amber-lang.net/learn.html) interactive crash course.
+    - and others. You can easily write an Amber library yourself.
+- Amber can use Javascript libraries; the "classic" IDE as well as Helios are built on [jQuery](http://www.jquery.com)
+- You can inline Javascript code and there are many ways to interact between Amber and Javascript
 
 
-Prerequisites
+Prerequisities
 -------------
 
-Amber is shipped as a cli tool to create new projects and assist with development tasks in a [npm](http://npmjs.org) package  `amber-cli`
-and as a library to be used by projects in a [bower](https://github.com/bower/bower) package `amber`.
+Amber cli tool to create new projects and assist with development tasks is in a [npm](http://npmjs.org) package  `amber-cli`.
+Amber engine and core library to be used in projects is in a [bower](https://github.com/bower/bower) package `amber`.
 
-For the installation to work, you need to have installed `node`, `npm` and `git` (in Windows, use Git for Windows and select "Run Git from Windows Command Prompt" and "Checkout Windows-style, commit Unix-style" installation options).
+For the installation to work, you need to have installed `node`, `npm` and `git`.
+Default `node` installers may install `npm` as well.
+To have `git` in Windows, use Git for Windows and select "Run Git from Windows Command Prompt" and "Checkout Windows-style, commit Unix-style" installation options.
 
 For UNIX-based OS (Linux distibutions, FreeBSD, ...) do
 
@@ -73,7 +69,6 @@ Use ``amber init``  to create a project of your own
 
     # (optional) Install backward compatibility
     bower install amber-compat-es5 --save   # be loadable in older browsers
-    bower install amber-compat-ie8 --save   # additional tweaks to load in IE8
 
 
 Start developing in Amber Smalltalk
@@ -88,9 +83,8 @@ Reporting issues
 
   - Report issues with the www.amber-lang.net website here: https://github.com/amber-smalltalk/amber-website/issues.
   - Report issues with the docs.amber-lang.net website here: https://github.com/amber-smalltalk/documentation/issues.
-  - Report issues with Amber itself or `amber` / `amberc` cli tools here: https://github.com/amber-smalltalk/amber/issues.
-Issues related to questions during `amber init` and structure of project created should be reported
-to https://github.com/amber-smalltalk/grunt-init-amber/issues instead.
+  - Report issues with `amber init` project template here: https://github.com/amber-smalltalk/grunt-init-amber/issues.
+  - Report issues with Amber engine, core library or `amber` / `amberc` cli tools here: https://github.com/amber-smalltalk/amber/issues.
   - Report issues with the Helios IDE here: https://github.com/amber-smalltalk/helios/issues.
 
 Please refer to [CONTRIBUTING.md](CONTRIBUTING.md) for further details.
@@ -107,9 +101,3 @@ License
 -------
 
 Amber is released under the MIT license. All contributions made for inclusion are considered to be under MIT.
-
-
-More infos
-----------
-
-More on the [project page](http://amber-lang.net)