Added README, license and copyright notice default tip
authorJan Vrany <jan.vrany@fit.cvut.cz>
Mon, 28 Sep 2015 14:39:57 +0100
changeset 202f28df70181a
parent 19 7597503194b8
Added README, license and copyright notice
README.md
license.txt
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README.md	Mon Sep 28 14:39:57 2015 +0100
     1.3 @@ -0,0 +1,66 @@
     1.4 +# Tea Language
     1.5 +
     1.6 +**Tea** is an experimental DSL based on Smalltalk language that compiles 
     1.7 +statically to (optimized) machine code. It depends on LLVM toolchain to 
     1.8 +actually optimize and generate target machine code. 
     1.9 +
    1.10 +## Prerequisites
    1.11 +
    1.12 +* An x96_64 Linux box
    1.13 +* GNU Make & C++ compiler (GCC / Clang would do it)
    1.14 +* LLVM *3.8* installation - requires libLLVM.so shared library
    1.15 +
    1.16 +## Loading into Smalltalk/X
    1.17 +
    1.18 +**1.** Get [Smalltalk/X jv-branch](https://swing.fit.cvut.cz/projects/stx-jv/) (preferably a night build).
    1.19 +
    1.20 +**2.** Clone *Tea*, *Ring* and *LLVM-S* repositories
    1.21 +
    1.22 +```
    1.23 +#!bash
    1.24 +    mkdir -p ~/SmalltalkXProjects/jv
    1.25 +    mkdir -p ~/SmalltalkXProjects/stx/goodies
    1.26 +    hg clone https://bitbucket.org/janvrany/stx-goodies-ring ~/SmalltalkXProjects/stx/goodies/ring
    1.27 +    hg clone https://bitbucket.org/janvrany/jv-llvm-s ~/SmalltalkXProjects/jv/llvm_s
    1.28 +    hg clone https://bitbucket.org/janvrany/jv-tea ~/SmalltalkXProjects/jv/tea
    1.29 +```
    1.30 +
    1.31 +**3.** Compile LLVM C Extension library
    1.32 +
    1.33 +```
    1.34 +#!bash
    1.35 +    cd ~/SmalltalkXProjects/jv/llvm_s/llvm_c_ext
    1.36 +    make LLVM_CONFIG=~/path/to/llvm-3.8/bin/llvm-config
    1.37 +```
    1.38 +
    1.39 +**4.** Load the package into Smalltalk/X 
    1.40 +```
    1.41 +#!smalltalk
    1.42 +    Smalltalk loadPackage: 'stx:goodies/ring'.
    1.43 +    Smalltalk loadPackage: 'jv:llvm_s'.
    1.44 +    Smalltalk loadPackage: 'jv:tea/compiler'.
    1.45 +    Smalltalk loadPackage: 'jv:tea/compiler/cli'.
    1.46 +```
    1.47 +
    1.48 +## Documentation 
    1.49 +
    1.50 +* [Project wiki](https://bitbucket.org/janvrany/jv-tea/wiki/Home)
    1.51 +
    1.52 +But do not expect much - it's more of an unsorted list of comments and thoughts
    1.53 +rather than documentation or even 'language specification'.
    1.54 +
    1.55 +## Authors
    1.56 +
    1.57 +* Jan Vrany
    1.58 +
    1.59 +## License
    1.60 +
    1.61 +This code is not an open-source (yet). You may use this code
    1.62 +for your own experiments and projects, given that:
    1.63 +
    1.64 +* all modification to the code will be sent to the
    1.65 +  original author for inclusion in future releases
    1.66 +* this is not used in any commercial software
    1.67 +
    1.68 +**This license is provisional and may (will) change in
    1.69 +a future.**
    1.70 \ No newline at end of file
     2.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     2.2 +++ b/license.txt	Mon Sep 28 14:39:57 2015 +0100
     2.3 @@ -0,0 +1,9 @@
     2.4 +This code is not an open-source (yet). You may use this code
     2.5 +for your own experiments and projects, given that:
     2.6 +
     2.7 +* all modification to the code will be sent to the
     2.8 +  original author for inclusion in future releases
     2.9 +* this is not used in any commercial software
    2.10 +
    2.11 +This license is provisional and may (will) change in
    2.12 +a future.
    2.13 \ No newline at end of file