README.md
author Jan Vrany <jan.vrany@fit.cvut.cz>
Mon, 08 Jul 2013 02:05:58 +0100
changeset 322 a34c1a00db29
parent 314 07827b628218
child 329 fb9fb5d13dd6
permissions -rw-r--r--
README updated. - Section on installation rewritten to use HGInstaller.st script. - Added Section Documentation

# 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

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

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:

- 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

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
[5]: http://swing.fit.cvut.cz/projects/stx/doc/online/english/help/HG/