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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
314
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     1
# Mercurial support for Smalltalk/X
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     2
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     3
**stx:libscm** is a new source code management library for [Smalltalk/X][1]. Currently only [Mercurial][2] is supported
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     4
but its design allow for other source code management systems to by plugged in if required.
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     5
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     6
The Mercurial support consist of:
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     7
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     8
* low-level Mercurial API allowing to query and manipulate Mercurial repositories
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     9
* Integration into Smalltalk/X IDE allowing to commit, branch or merge Smalltalk/X packages directly within Smalltalk/x IDE. 
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    10
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    11
## Installation
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    12
322
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    13
1. **Install Mercurial command line client.**
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    14
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    15
See [Mercurial wiki page](http://mercurial.selenic.com/wiki/Download) for details how to install
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    16
Mercurial on your machine. 
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    17
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    18
2. **Download installer script.**
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    19
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    20
Download `HGInstaller.st` script from 
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    21
[https://bitbucket.org/janvrany/stx-libscm/raw/default/mercurial/HGInstaller.st](https://bitbucket.org/janvrany/stx-libscm/raw/default/mercurial/HGInstaller.st)
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    22
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    23
3. **Run the script.**
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    24
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    25
    stx --execute HGInstaller.st
314
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    26
322
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    27
See [installation instruction](https://bitbucket.org/janvrany/stx-libscm/wiki/Installation) for more details
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    28
on installer options and on manual installation.
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    29
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    30
## Supported version
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    31
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    32
**stx:libscm** supports all three Smalltalk/X versions:
314
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    33
322
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    34
- Smalltalk/X 6.2.2 (latest official version released on July 2012)
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    35
- Smalltalk/X "eXept HEAD"
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    36
- Smalltalk/X "jv branch" (an experimental Smalltalk/X version with many improvements)
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    37
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    38
See [supported versions](https://bitbucket.org/janvrany/stx-libscm/wiki/SupportedVersion) for details on each
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    39
version as not all features are supported on all Smalltalk/X versions.
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    40
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    41
## Documentation
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    42
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    43
- [Wiki][4]
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    44
- [User guide][5] (always incomplete :-)
314
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    45
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    46
## Support
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    47
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    48
As the stx:libscm comes free of charge, it comes with no warranty or whatsoever. For (commercial) support please 
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    49
contact the author or [eXept Software AG](http://www.exept.de)
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    50
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    51
## Author
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    52
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    53
Jan Vrany `<jan.vrany [at] fit.cvut.cz>`
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    54
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    55
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    56
[1]: http://www.exept.de/en/products/smalltalkx
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    57
[2]: http://mercurial.selenic.com/
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    58
[3]: http://www.exept.de/en/products/smalltalkx/download
322
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    59
[4]: https://bitbucket.org/janvrany/stx-libscm/wiki/Home
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    60
[5]: http://swing.fit.cvut.cz/projects/stx/doc/online/english/help/HG/