README.md
author Jan Vrany <jan.vrany@labware.com>
Tue, 23 Jun 2020 12:16:02 +0100
changeset 294 0f3980335d2b
parent 36 2d53d5e44347
permissions -rw-r--r--
CI: do not archive (and publish) i686 versions any more 32bit Intel is phasing out already - Microsoft is dropping i686 Windows 10, many Linux distros are dropping i686 architecture too. We still build and test 32bit versions, but no longer archive it nor publish it to save space and bandwidth. We might make it available again upon request.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
12
5bd69db5ca2b Added short README.md and LICENSE.txt
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     1
# Smalltalk/X jv-branch build tool
5bd69db5ca2b Added short README.md and LICENSE.txt
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     2
36
2d53d5e44347 Small tweaks in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 12
diff changeset
     3
This tools allows anyone to rebuild [Smalltalk/X jv-branch][1] from (almost) scratch. It fetches sources
12
5bd69db5ca2b Added short README.md and LICENSE.txt
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     4
from various repositories, put them together and compile the whole thing. For those without an access to
36
2d53d5e44347 Small tweaks in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 12
diff changeset
     5
**stc** and **librun** sources, it automatically downloads latest pre-build versions from [SWING CI server][2].
12
5bd69db5ca2b Added short README.md and LICENSE.txt
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     6
5bd69db5ca2b Added short README.md and LICENSE.txt
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     7
## A quick quide for the impatient
5bd69db5ca2b Added short README.md and LICENSE.txt
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     8
5bd69db5ca2b Added short README.md and LICENSE.txt
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     9
In shell, execute:
5bd69db5ca2b Added short README.md and LICENSE.txt
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    10
    
5bd69db5ca2b Added short README.md and LICENSE.txt
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    11
    hg clone https://bitbucket.org/janvrany/stx-goodies-builder-rake stx-jv
5bd69db5ca2b Added short README.md and LICENSE.txt
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    12
    cd stx-jv
5bd69db5ca2b Added short README.md and LICENSE.txt
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    13
    rake
5bd69db5ca2b Added short README.md and LICENSE.txt
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    14
36
2d53d5e44347 Small tweaks in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 12
diff changeset
    15
Go out for a short or long walk, depending on your internet connection and CPU power. Once `rake` finishes, you have compiled [Smalltalk/X jv-branch][1]yourself. Have fun!
12
5bd69db5ca2b Added short README.md and LICENSE.txt
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    16
5bd69db5ca2b Added short README.md and LICENSE.txt
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    17
## Usage
5bd69db5ca2b Added short README.md and LICENSE.txt
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    18
36
2d53d5e44347 Small tweaks in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 12
diff changeset
    19
For more details on usage please see [wiki][3].
12
5bd69db5ca2b Added short README.md and LICENSE.txt
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    20
5bd69db5ca2b Added short README.md and LICENSE.txt
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    21
## Disclaimer
5bd69db5ca2b Added short README.md and LICENSE.txt
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    22
5bd69db5ca2b Added short README.md and LICENSE.txt
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    23
The internals of these build scripts are mess...emh...convoluted. A lot of hacks accumulated over years.
5bd69db5ca2b Added short README.md and LICENSE.txt
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    24
We aim to clean that up, if time allows. For now, it does its job. 
5bd69db5ca2b Added short README.md and LICENSE.txt
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    25
36
2d53d5e44347 Small tweaks in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 12
diff changeset
    26
## Contributing
2d53d5e44347 Small tweaks in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 12
diff changeset
    27
2d53d5e44347 Small tweaks in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 12
diff changeset
    28
Anyone wishing to help is welcomed! If you encounter a problem. please 
2d53d5e44347 Small tweaks in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 12
diff changeset
    29
fill in a report to [Smalltalk/X jv-branch bug tracker][4]. 
2d53d5e44347 Small tweaks in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 12
diff changeset
    30
2d53d5e44347 Small tweaks in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 12
diff changeset
    31
To contribute,  either
2d53d5e44347 Small tweaks in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 12
diff changeset
    32
2d53d5e44347 Small tweaks in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 12
diff changeset
    33
* fork the [repository on BitBucket][5] and [send a pull request][6]. 
2d53d5e44347 Small tweaks in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 12
diff changeset
    34
* send a patch to [stx-jv@googlegroups.com][7].
12
5bd69db5ca2b Added short README.md and LICENSE.txt
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    35
5bd69db5ca2b Added short README.md and LICENSE.txt
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    36
## License
5bd69db5ca2b Added short README.md and LICENSE.txt
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    37
5bd69db5ca2b Added short README.md and LICENSE.txt
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    38
Copyright (c) 2010-now Jan Vrany <jan.vrany (a) fit.cvut.cz>
5bd69db5ca2b Added short README.md and LICENSE.txt
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    39
5bd69db5ca2b Added short README.md and LICENSE.txt
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    40
This software is licensed under "MIT license". You may find a full license text in `LICENSE.txt`.
5bd69db5ca2b Added short README.md and LICENSE.txt
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    41
5bd69db5ca2b Added short README.md and LICENSE.txt
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    42
[1]: https://swing.fit.cvut.cz/projects/stx-jv/
5bd69db5ca2b Added short README.md and LICENSE.txt
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    43
[2]: https://swing.fit.cvut.cz/jenkins
36
2d53d5e44347 Small tweaks in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 12
diff changeset
    44
[3]: https://swing.fit.cvut.cz/projects/stx-jv/wiki/Documentation/BuildingStXWithRakefiles
2d53d5e44347 Small tweaks in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 12
diff changeset
    45
[4]: https://swing.fit.cvut.cz/projects/stx-jv/newticket
2d53d5e44347 Small tweaks in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 12
diff changeset
    46
[5]: https://bitbucket.org/janvrany/stx-goodies-builder-rake
2d53d5e44347 Small tweaks in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 12
diff changeset
    47
[6]: https://www.atlassian.com/git/tutorials/making-a-pull-request/
2d53d5e44347 Small tweaks in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 12
diff changeset
    48
[7]: https://groups.google.com/forum/#!forum/stx-jv