-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
42d0e32
commit 08dc983
Showing
5 changed files
with
34 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,36 +9,49 @@ Conjure can be installed either by downloading a binary distribution, or by comp | |
Downloading a binary | ||
-------------------- | ||
|
||
Conjure is available as an executable binary for Linux, MacOS, and Windows. | ||
Conjure is available as an executable binary for Linux and MacOS. | ||
If it is available for your platform, you can just `download it <https://www.github.com/conjure-cp/conjure/releases/latest>`_ and run it. | ||
It may be useful to save the binary under a directory that is in your search PATH, so you do not have to type the full path to the Conjure executable to run it. | ||
|
||
For Windows, please use the Linux binaries with the | ||
`Windows Subsystem for Linux <https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux>`_. | ||
|
||
|
||
Compiling from source | ||
--------------------- | ||
|
||
In order to compile Conjure on your computer, please download the source code from `GitHub <https://github.com/conjure-cp/conjure>`_. | ||
Conjure is implemented in Haskell, it can be compiled using either `cabal-install <http://wiki.haskell.org/Cabal-Install>`_ or `stack <https://docs.haskellstack.org/en/stable/README/>`_. | ||
|
||
It comes with a Makefile which will use Stack by default. | ||
The default target in the Makefile will install Stack using the standard procedures (which involves downloading and running a script). | ||
For more precise control, you might want to consider installing the Haskell tools beforehand instead of using the Makefile. | ||
|
||
.. code-block:: bash | ||
git clone [email protected]:conjure-cp/conjure.git | ||
cd conjure | ||
make install | ||
BIN_DIR=/somewhere/in/your/path make install | ||
Conjure is implemented in Haskell, it can be compiled using either `cabal-install <http://wiki.haskell.org/Cabal-Install>`_ or `stack <https://docs.haskellstack.org/en/stable/README/>`_. | ||
|
||
It comes with a Makefile which will use Stack by default. | ||
The default target in the Makefile will install Stack using the standard procedures (which involves downloading and running a script). | ||
For more precise control, you might want to consider installing the Haskell tools beforehand instead of using the Makefile. | ||
|
||
Installation is known to work with | ||
`GHC-8.0.2 <http://www.haskell.org/ghc/download_ghc_8_0_2.html>`_, and | ||
`GHC-8.2.2 <http://www.haskell.org/ghc/download_ghc_8_2_2.html>`_, and | ||
`GHC-8.4.2 <http://www.haskell.org/ghc/download_ghc_8_4_2.html>`_. | ||
`GHC-8.0.2 <http://www.haskell.org/ghc/download_ghc_8_0_2.html>`_, | ||
`GHC-8.2.2 <http://www.haskell.org/ghc/download_ghc_8_2_2.html>`_, | ||
`GHC-8.4.2 <http://www.haskell.org/ghc/download_ghc_8_4_4.html>`_, and | ||
`GHC-8.4.2 <http://www.haskell.org/ghc/download_ghc_8_6_5.html>`_. | ||
|
||
In addition, a number of supported backend solvers can be compiled using the `make solvers` target. | ||
This target also takes a BIN_DIR environment variable to control the location of the solver executables. | ||
|
||
.. code-block:: bash | ||
BIN_DIR=/somewhere/in/your/path make solvers | ||
Installing Savile Row | ||
--------------------- | ||
|
||
Since Conjure works by generating an Essence' model, Savile Row is a vital tool when using it. | ||
Savile Row can be downloaded from `its website <http://savilerow.cs.st-andrews.ac.uk>`_. | ||
|
||
You do not need to download Savile Row separately when you compile Conjure from source. | ||
An up-to-date version of Savile Row is also copied next to the Conjure executable. | ||
|
08dc983
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some of these links are messed up: 8.4.2 refers to 8.4.4, 8.4.2 refers to 8.6.5?
08dc983
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed, thanks.