README updated.
authorJan Vrany <jan.vrany@fit.cvut.cz>
Mon, 08 Jul 2013 02:05:58 +0100
changeset 322 a34c1a00db29
parent 321 06405fddc70d
child 323 7a39e728a3ac
README updated. - Section on installation rewritten to use HGInstaller.st script. - Added Section Documentation
README.md
--- a/README.md	Mon Jul 08 00:43:30 2013 +0100
+++ b/README.md	Mon Jul 08 02:05:58 2013 +0100
@@ -10,13 +10,38 @@
 
 ## Installation
 
-**stx:libscm** supports three different versions of Smalltalk/X:
+1. **Install Mercurial command line client.**
+
+See [Mercurial wiki page](http://mercurial.selenic.com/wiki/Download) for details how to install
+Mercurial on your machine. 
+
+2. **Download installer script.**
+
+Download `HGInstaller.st` script from 
+[https://bitbucket.org/janvrany/stx-libscm/raw/default/mercurial/HGInstaller.st](https://bitbucket.org/janvrany/stx-libscm/raw/default/mercurial/HGInstaller.st)
+
+3. **Run the script.**
+
+    stx --execute HGInstaller.st
 
-* Smalltalk/X 6.2.2 (the latest public release by eXept, Jun 2012)
-* Smalltalk/X "jv-branch"
-* Smalltalk/X "eXept HEAD"
+See [installation instruction](https://bitbucket.org/janvrany/stx-libscm/wiki/Installation) for more details
+on installer options and on manual installation.
+
+## Supported version
+
+**stx:libscm** supports all three Smalltalk/X versions:
 
-For more details, see [installation instruction](https://bitbucket.org/janvrany/stx-libscm/wiki/Installation) on [wiki][4]
+- Smalltalk/X 6.2.2 (latest official version released on July 2012)
+- Smalltalk/X "eXept HEAD"
+- Smalltalk/X "jv branch" (an experimental Smalltalk/X version with many improvements)
+
+See [supported versions](https://bitbucket.org/janvrany/stx-libscm/wiki/SupportedVersion) for details on each
+version as not all features are supported on all Smalltalk/X versions.
+
+## Documentation
+
+- [Wiki][4]
+- [User guide][5] (always incomplete :-)
 
 ## Support
 
@@ -31,4 +56,5 @@
 [1]: http://www.exept.de/en/products/smalltalkx
 [2]: http://mercurial.selenic.com/
 [3]: http://www.exept.de/en/products/smalltalkx/download
-[4]: https://bitbucket.org/janvrany/stx-libscm/wiki/Home
\ No newline at end of file
+[4]: https://bitbucket.org/janvrany/stx-libscm/wiki/Home
+[5]: http://swing.fit.cvut.cz/projects/stx/doc/online/english/help/HG/
\ No newline at end of file