diff --git a/README.rst b/README.rst index 9cab614..1b24119 100644 --- a/README.rst +++ b/README.rst @@ -1,4 +1,6 @@ -|License| |Build Status| |Docs| |Python Versions| |Downloads| |Status| |Code Coverage| +|CondaDownloads| |Downloads| +|Python Versions| +|License| |Build Status| |Status| |Docs| |Code Coverage| .. image:: https://github.com/python-constraint/python-constraint/raw/main/docs/assets/logo/N-Queens_problem_Python.svg :align: center @@ -7,21 +9,22 @@ python-constraint ================= -| This software is now back to active development / maintainance status. -| IMPORTANT: the new version can be installed with `pip install python-constraint2`, as the original pip release will not be updated. +| ⚠️ IMPORTANT: this software must be installed with ``pip install python-constraint2``, as the original pip release will not be updated. +| A `Conda Forge `_ / `Mamba `_ version is also available: ``conda install python-constraint2``. +| | For an overview of recent changes, visit the `Changelog `_. | The complete documentation can be found `here `_. - +| | New: writing constraints in the new string format is preferable over functions and lambdas. | These strings, even as compound statements, are automatically parsed to faster built-in constraints, are more concise, and do not require constraint solving familiarity by the user to be efficient. | For example, :code:`problem.addConstraint(["50 <= x * y < 100"])` is parsed to :code:`[MinProdConstraint(50, ["x", "y"]), MaxProdConstraint(100, ["x", "y"])]`. | Similarly, :code:`problem.addConstraint(["x / y == z"])` is parsed to :code:`[ExactProdConstraint("x", ["z", "y"])]`. | This feature is in beta and subject to possible change, please provide feedback. - +| .. contents:: :local: :depth: 1 - +| Introduction ------------ The :code:`python-constraint` module offers efficient solvers for `Constraint Satisfaction Problems (CSPs) `_ over finite domains in an accessible Python package. @@ -155,6 +158,15 @@ Download and install $ pip install python-constraint2 +Conda / Mamba: + +.. code-block:: shell + + $ conda config --add channels conda-forge + $ conda config --set channel_priority strict + $ conda install python-constraint2 + $ mamba install python-constraint2 + Testing ------- @@ -208,6 +220,9 @@ But it's probably better to `open an issue