Skip to content

Commit

Permalink
Release v2.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
ozgurakgun committed Jun 23, 2019
1 parent 42d0e32 commit 08dc983
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 17 deletions.
8 changes: 6 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@

# v2.3.0 (2019-06-23)

Please check [this page](https://github.com/conjure-cp/conjure/compare/v2.2.0...v2.3.0) to see a list of all changes since the previous release.

# v2.2.0 (2018-08-27)

- Bug fix: Avoid generating names that are used in the input file.
- Improvements to the refinement of partitions. Do not generate redundant structural constraints.
- Many more (I promise to write them soon!)
- And many more...

For now, check [this page](https://github.com/conjure-cp/conjure/compare/v2.1.0...v2.2.0) which lists all changes since the previous release.
There has been several bugfixes, performance improvements and new features in the last year. Please check [this page](https://github.com/conjure-cp/conjure/compare/v2.1.0...v2.2.0) to see a list of all changes since the previous release.

# v2.1.0 (2017-08-24)

Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright 2009-2018 Özgür Akgün
Copyright 2009-2019 Özgür Akgün
School of Computer Science, University of St Andrews

All rights reserved.
Expand Down
2 changes: 1 addition & 1 deletion conjure-cp.cabal
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

Name: conjure-cp
Version: 2.2.0
Version: 2.3.0
Synopsis: Conjure: The Automated Constraint Modelling Tool
Description: .
Homepage: http://github.com/conjure-cp/conjure
Expand Down
6 changes: 3 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,17 +51,17 @@

# General information about the project.
project = u'Conjure'
copyright = u'2009-2018, Özgür Akgün'
copyright = u'2009-2019, Özgür Akgün'
author = u'Özgür Akgün'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = u'2.2.0'
version = u'2.3.0'
# The full version, including alpha/beta/rc tags.
release = u'2.2.0'
release = u'2.3.0'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
33 changes: 23 additions & 10 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

2 comments on commit 08dc983

@ott2
Copy link
Collaborator

@ott2 ott2 commented on 08dc983 Jun 24, 2019

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?

@ozgurakgun
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed, thanks.

Please sign in to comment.