Showing with 26 additions and 11 deletions.
  1. +2 −2 Clafer.sublime-build
  2. +13 −6 README.md
  3. +1 −1 SublimeREPL/config/ClaferIG/IGC.sublime-menu
  4. +10 −2 messages/install.md
4 changes: 2 additions & 2 deletions Clafer.sublime-build
View file
Expand Up @@ -2,11 +2,11 @@
, "$file"
, "-m=alloy"
, "-m=choco"
, "-m=html"
, "-m=html"
, "--self-contained"
, "-k"
, "-v"
, "--tooldir=\"$packages/Clafer-Bin\""
, "--tooldir=$packages/Clafer-Bin"
]
, "selector": "source.clafer"
}
19 changes: 13 additions & 6 deletions README.md
View file
@@ -1,11 +1,11 @@
Clafer Tools
=============

v0.4.2
v0.4.3

Integration of [Clafer Compiler and Instance Generators](http://clafer.org) into [Sublime Text 2/3](http://www.sublimetext.com/).

See release notes for [Clafer 0.4.2](http://www.clafer.org/2015/09/clafer-claferig-claferwiki.html).
See release notes for [Clafer 0.4.3](http://www.clafer.org/2015/10/clafer-tools-042-released.html).

Contributors
------------
Expand All @@ -16,7 +16,7 @@ Features and Usage
------------------

* Syntax highlighting of keywords, operators, comments, and integer and string literals
* Compilation `<CTRL>+b`. To change parameters of the command:
* Compilation and validation `<CTRL>+b`. To change parameters of the command:
* `Preferences->Browse Packages`
* `cd Clafer Tools`
* edit `Clafer.sublime-build`
Expand All @@ -40,13 +40,19 @@ Installation
* on Mac, use the `merge` option not `replace`
3. Download the latest binary distribution of Clafer Tools
* [Clafer Tools](http://gsd.uwaterloo.ca/clafer-tools-binary-distributions)
* Unzip the contents of the folder `clafer-tools-0.4.2` into `Packages/Clafer-Bin`
* Make sure the folder structure is NOT `Packages/Clafer-Bin/clafer-tools-0.4.2`, that is, the contents of the folder `clafer-tools-0.4.2` are directly inside `Clafer-Bin`
* Unzip the contents of the folder `clafer-tools-0.4.3` into `Packages/Clafer-Bin`
* Make sure the folder structure is NOT `Packages/Clafer-Bin/clafer-tools-0.4.3`, that is, the contents of the folder `clafer-tools-0.4.3` are directly inside `Clafer-Bin`
* add `Clafer-Bin` to the variable `PATH`.
4. On Windows only
* Alloy-based instance generator only works with 32bit Java on Windows and if you only have 64bit Java installation, you will see an error: `Exception in thread "main" java.lang.UnsatisfiedLinkError: no minisatproverx1 in java.library.path`.

### Known Limitations and Workarounds

* ClaferSMT in Clafer Tools 0.3.6.1 binary depends on the python package `bintrees`, to install execute `pip install bintrees` on Windows or `pip3 install bintrees` on Linux and Mac.
* On Windows - Setting the PATH to 32bit Java installation
* install [32bit JDK](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) but do not modify the PATH to point to it (there's no 32bit JRE anymore)
* in Sublime Text
* `Preferences->Package Settings->SublimeREPL->Settings - Default`
* set `default_extended_env` as `"default_extend_env": {"PATH": "C:/Program Files (x86)/Java/jdk1.8.0_66/bin;{PATH}"},`

* On Linux and Mac
* the Python 3 executable is called `python3` and the best solution is to create a symlink called `python` pointing to `/usr/bin/python3`
Expand All @@ -65,6 +71,7 @@ Installation
* create a symlink `sudo ln -s ~/Library/Application\ Support/Sublime\ Text\ 3/Packages/Clafer-Bin/clafer /usr/bin/clafer` so that `clafer` executable will be visible on the default `PATH`.
5. to conveniently use ClaferChocoIG, move the script `claferchocoig.sh` (included in Mac binary distro) to `/usr/bin` by executing `sudo mv ~/Library/Application\ Support/Sublime\ Text\ 3/Packages/Clafer-Bin/claferchocoig.sh /usr/bin`.

* ClaferSMT in Clafer Tools 0.3.6.1 binary depends on the python package `bintrees`, to install execute `pip install bintrees` on Windows or `pip3 install bintrees` on Linux and Mac.


Planned Improvements
Expand Down
2 changes: 1 addition & 1 deletion SublimeREPL/config/ClaferIG/IGC.sublime-menu
View file
Expand Up @@ -17,7 +17,7 @@
"encoding": "utf8",
"cmd": [ "java"
, "-jar"
, "claferchocoig.jar"
, "chocosolver.jar"
, "--repl"
, "--prettify"
, "--file"
Expand Down
12 changes: 10 additions & 2 deletions messages/install.md
View file
Expand Up @@ -7,12 +7,20 @@ To finish the installation
* copy the folder `SublimeREPL` from `Clafer Tools` to `Packages`
2. Download the latest binary distribution of Clafer Tools
* [Clafer Tools](http://gsd.uwaterloo.ca/clafer-tools-binary-distributions)
* Unzip the contents of the folder `clafer-tools-0.4.2` into `Packages/Clafer-Bin`
* Make sure the folder structure is NOT `Packages/Clafer-Bin/clafer-tools-0.4.2`, that is, the contents of the folder `clafer-tools-0.4.2` are directly inside `Clafer-Bin`
* Unzip the contents of the folder `clafer-tools-0.4.2.1` into `Packages/Clafer-Bin`
* Make sure the folder structure is NOT `Packages/Clafer-Bin/clafer-tools-0.4.2.1`, that is, the contents of the folder `clafer-tools-0.4.2.1` are directly inside `Clafer-Bin`
* add `Clafer-Bin` to the variable `PATH`.
4. On Windows only
* Alloy-based instance generator only works with 32bit Java on Windows and if you only have 64bit Java installation, you will see an error: `Exception in thread "main" java.lang.UnsatisfiedLinkError: no minisatproverx1 in java.library.path`.

### Known Limitations and Workarounds

* On Windows - Setting the PATH to 32bit Java installation
* install [32bit JDK](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) but do not modify the PATH to point to it (there's no 32bit JRE anymore)
* in Sublime Text
* `Preferences->Package Settings->SublimeREPL->Settings - Default`
* set `default_extended_env` as `"default_extend_env": {"PATH": "C:/Program Files (x86)/Java/jdk1.8.0_66/bin;{PATH}"},`

*. ClaferSMT in Clafer Tools 0.3.6.1 binary depends on the python package `bintrees`, to install execute `pip install bintrees` on Windows or `pip3 install bintrees` on Linux and Mac.

*. On Linux and Mac
Expand Down