README.md
changeset 36 2d53d5e44347
parent 12 5bd69db5ca2b
equal deleted inserted replaced
35:9d3a72ddb471 36:2d53d5e44347
     1 # Smalltalk/X jv-branch build tool
     1 # Smalltalk/X jv-branch build tool
     2 
     2 
     3 This tools allows anyone to rebuild [Smalltalk/X jv-branch](1) from (almost) scratch. It fetches sources
     3 This tools allows anyone to rebuild [Smalltalk/X jv-branch][1] from (almost) scratch. It fetches sources
     4 from various repositories, put them together and compile the whole thing. For those without an access to
     4 from various repositories, put them together and compile the whole thing. For those without an access to
     5 **stc** and **librun** sources, it automatically downloads latest pre-build versions from [SWING CI server](2).
     5 **stc** and **librun** sources, it automatically downloads latest pre-build versions from [SWING CI server][2].
     6 
     6 
     7 ## A quick quide for the impatient
     7 ## A quick quide for the impatient
     8 
     8 
     9 In shell, execute:
     9 In shell, execute:
    10     
    10     
    11     hg clone https://bitbucket.org/janvrany/stx-goodies-builder-rake stx-jv
    11     hg clone https://bitbucket.org/janvrany/stx-goodies-builder-rake stx-jv
    12     cd stx-jv
    12     cd stx-jv
    13     rake
    13     rake
    14 
    14 
    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!
    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!
    16 
    16 
    17 ## Usage
    17 ## Usage
    18 
    18 
    19 For more details on usage please see [wiki](3).
    19 For more details on usage please see [wiki][3].
    20 
       
    21 
    20 
    22 ## Disclaimer
    21 ## Disclaimer
    23 
    22 
    24 The internals of these build scripts are mess...emh...convoluted. A lot of hacks accumulated over years.
    23 The internals of these build scripts are mess...emh...convoluted. A lot of hacks accumulated over years.
    25 We aim to clean that up, if time allows. For now, it does its job. 
    24 We aim to clean that up, if time allows. For now, it does its job. 
    26 
    25 
    27 Anyone wishing to help is welcomed!
    26 ## Contributing
       
    27 
       
    28 Anyone wishing to help is welcomed! If you encounter a problem. please 
       
    29 fill in a report to [Smalltalk/X jv-branch bug tracker][4]. 
       
    30 
       
    31 To contribute,  either
       
    32 
       
    33 * fork the [repository on BitBucket][5] and [send a pull request][6]. 
       
    34 * send a patch to [stx-jv@googlegroups.com][7].
    28 
    35 
    29 ## License
    36 ## License
    30 
    37 
    31 Copyright (c) 2010-now Jan Vrany <jan.vrany (a) fit.cvut.cz>
    38 Copyright (c) 2010-now Jan Vrany <jan.vrany (a) fit.cvut.cz>
    32 
    39 
    33 This software is licensed under "MIT license". You may find a full license text in `LICENSE.txt`.
    40 This software is licensed under "MIT license". You may find a full license text in `LICENSE.txt`.
    34 
    41 
    35 [1]: https://swing.fit.cvut.cz/projects/stx-jv/
    42 [1]: https://swing.fit.cvut.cz/projects/stx-jv/
    36 [2]: https://swing.fit.cvut.cz/jenkins
    43 [2]: https://swing.fit.cvut.cz/jenkins
    37 [3]: https://swing.fit.cvut.cz/projects/stx-jv/wiki/Documentation/BuildingStXWithRakefiles
    44 [3]: https://swing.fit.cvut.cz/projects/stx-jv/wiki/Documentation/BuildingStXWithRakefiles
       
    45 [4]: https://swing.fit.cvut.cz/projects/stx-jv/newticket
       
    46 [5]: https://bitbucket.org/janvrany/stx-goodies-builder-rake
       
    47 [6]: https://www.atlassian.com/git/tutorials/making-a-pull-request/
       
    48 [7]: https://groups.google.com/forum/#!forum/stx-jv