Added short README.md and LICENSE.txt
authorJan Vrany <jan.vrany@fit.cvut.cz>
Thu, 26 May 2016 10:21:20 +0100
changeset 12 5bd69db5ca2b
parent 11 f7dc950d8df8
child 13 ba905210e6bb
Added short README.md and LICENSE.txt
LICENSE.txt
README.md
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/LICENSE.txt	Thu May 26 10:21:20 2016 +0100
@@ -0,0 +1,20 @@
+Copyright (c) 2010-now Jan Vrany <jan.vrany (a) fit.cvut.cz>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\ No newline at end of file
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Thu May 26 10:21:20 2016 +0100
@@ -0,0 +1,37 @@
+# Smalltalk/X jv-branch build tool
+
+This tools allows anyone to rebuild [Smalltalk/X jv-branch](1) from (almost) scratch. It fetches sources
+from various repositories, put them together and compile the whole thing. For those without an access to
+**stc** and **librun** sources, it automatically downloads latest pre-build versions from [SWING CI server](2).
+
+## A quick quide for the impatient
+
+In shell, execute:
+    
+    hg clone https://bitbucket.org/janvrany/stx-goodies-builder-rake stx-jv
+    cd stx-jv
+    rake
+
+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!
+
+## Usage
+
+For more details on usage please see [wiki](3).
+
+
+## Disclaimer
+
+The internals of these build scripts are mess...emh...convoluted. A lot of hacks accumulated over years.
+We aim to clean that up, if time allows. For now, it does its job. 
+
+Anyone wishing to help is welcomed!
+
+## License
+
+Copyright (c) 2010-now Jan Vrany <jan.vrany (a) fit.cvut.cz>
+
+This software is licensed under "MIT license". You may find a full license text in `LICENSE.txt`.
+
+[1]: https://swing.fit.cvut.cz/projects/stx-jv/
+[2]: https://swing.fit.cvut.cz/jenkins
+[3]: https://swing.fit.cvut.cz/projects/stx-jv/wiki/Documentation/BuildingStXWithRakefiles
\ No newline at end of file