README.md
author Jan Vrany <jan.vrany@labware.com>
Fri, 03 Dec 2021 11:40:55 +0000
changeset 934 84b7d3b8f3a6
parent 559 66900c88efbb
permissions -rw-r--r--
Add comment `HGWorkingCopy >> statusesOf:` ...to ease debugging when assertion fails.
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
329
fb9fb5d13dd6 Updated README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 322
diff changeset
    13
1.  **Install Mercurial command line client.** 
fb9fb5d13dd6 Updated README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 322
diff changeset
    14
    
fb9fb5d13dd6 Updated README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 322
diff changeset
    15
    See [Mercurial wiki page](http://mercurial.selenic.com/wiki/Download) for details 
fb9fb5d13dd6 Updated README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 322
diff changeset
    16
    how to install Mercurial on your machine. 
322
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    17
329
fb9fb5d13dd6 Updated README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 322
diff changeset
    18
2.  **Download and run an installer script**
fb9fb5d13dd6 Updated README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 322
diff changeset
    19
   
fb9fb5d13dd6 Updated README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 322
diff changeset
    20
    Download [`HGInstaller.st`](https://bitbucket.org/janvrany/stx-libscm/raw/default/mercurial/HGInstaller.st) script and run it as:
322
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    21
329
fb9fb5d13dd6 Updated README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 322
diff changeset
    22
    `stx --execute HGInstaller.st`
314
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    23
329
fb9fb5d13dd6 Updated README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 322
diff changeset
    24
**NOTE**: Smalltalk/X *jv-branch* has Mercurial support already included,
fb9fb5d13dd6 Updated README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 322
diff changeset
    25
so there's no need to install it explicitly.
fb9fb5d13dd6 Updated README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 322
diff changeset
    26
fb9fb5d13dd6 Updated README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 322
diff changeset
    27
See [installation instruction](https://bitbucket.org/janvrany/stx-libscm/wiki/Installation) for more details.
322
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    28
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    29
## Supported version
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    30
559
66900c88efbb Updated information about supported Smalltalk/X versions in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 558
diff changeset
    31
**stx:libscm** works - to some extent - on three Smalltalk/X versions
314
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    32
559
66900c88efbb Updated information about supported Smalltalk/X versions in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 558
diff changeset
    33
- [Smalltalk/X "jv branch"][6] - fully "supported" (i.e, all features should work, this is where libscm development takes place)
66900c88efbb Updated information about supported Smalltalk/X versions in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 558
diff changeset
    34
- Smalltalk/X "eXept HEAD" - should work, though not regularly tested. If not, please file in a bugreport here. 
66900c88efbb Updated information about supported Smalltalk/X versions in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 558
diff changeset
    35
- [Smalltalk/X 6.2.2][1] - generally not supported. The last version working on 6.2.2 was released as [1.0][7], which allows basic commit. If you need more recent version running on 6.2.2 (or any other older version), please contact the autor. 
322
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    36
559
66900c88efbb Updated information about supported Smalltalk/X versions in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 558
diff changeset
    37
66900c88efbb Updated information about supported Smalltalk/X versions in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 558
diff changeset
    38
For more detauls see [release notes](https://bitbucket.org/janvrany/stx-libscm/wiki/ReleaseNotes.md).
322
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    39
329
fb9fb5d13dd6 Updated README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 322
diff changeset
    40
## More Information
322
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    41
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    42
- [Wiki][4]
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    43
- [User guide][5] (always incomplete :-)
314
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    44
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    45
## Support
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    46
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    47
As the stx:libscm comes free of charge, it comes with no warranty or whatsoever. For (commercial) support please 
559
66900c88efbb Updated information about supported Smalltalk/X versions in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 558
diff changeset
    48
contact the author.
314
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    49
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    50
## Author
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    51
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    52
Jan Vrany `<jan.vrany [at] fit.cvut.cz>`
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    53
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    54
558
736803450f76 Fixed issue #58: Broken url in main readme
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 329
diff changeset
    55
[1]: http://www.exept.de/en/products/smalltalk-x.html
314
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    56
[2]: http://mercurial.selenic.com/
07827b628218 Added README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    57
[3]: http://www.exept.de/en/products/smalltalkx/download
322
a34c1a00db29 README updated.
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 314
diff changeset
    58
[4]: https://bitbucket.org/janvrany/stx-libscm/wiki/Home
559
66900c88efbb Updated information about supported Smalltalk/X versions in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 558
diff changeset
    59
[5]: http://swing.fit.cvut.cz/projects/stx/doc/online/english/help/HG/
66900c88efbb Updated information about supported Smalltalk/X versions in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 558
diff changeset
    60
[6]: https://swing.fit.cvut.cz/projects/stx-jv/
66900c88efbb Updated information about supported Smalltalk/X versions in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 558
diff changeset
    61
[7]: https://bitbucket.org/janvrany/stx-libscm/src/1.0