README.md
changeset 314 07827b628218
child 322 a34c1a00db29
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Fri Jul 05 03:08:07 2013 +0100
@@ -0,0 +1,34 @@
+# Mercurial support for Smalltalk/X
+
+**stx:libscm** is a new source code management library for [Smalltalk/X][1]. Currently only [Mercurial][2] is supported
+but its design allow for other source code management systems to by plugged in if required.
+
+The Mercurial support consist of:
+
+* low-level Mercurial API allowing to query and manipulate Mercurial repositories
+* Integration into Smalltalk/X IDE allowing to commit, branch or merge Smalltalk/X packages directly within Smalltalk/x IDE. 
+
+## Installation
+
+**stx:libscm** supports three different versions of Smalltalk/X:
+
+* Smalltalk/X 6.2.2 (the latest public release by eXept, Jun 2012)
+* Smalltalk/X "jv-branch"
+* Smalltalk/X "eXept HEAD"
+
+For more details, see [installation instruction](https://bitbucket.org/janvrany/stx-libscm/wiki/Installation) on [wiki][4]
+
+## Support
+
+As the stx:libscm comes free of charge, it comes with no warranty or whatsoever. For (commercial) support please 
+contact the author or [eXept Software AG](http://www.exept.de)
+
+## Author
+
+Jan Vrany `<jan.vrany [at] fit.cvut.cz>`
+
+
+[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