From 6c18e467b7ab9cf5d8a31854d75f5993b3e0417e Mon Sep 17 00:00:00 2001 From: Niklas Dewally Date: Fri, 24 Nov 2023 10:58:25 +0000 Subject: [PATCH] Add contributors guide to the readme --- readme.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index 61f6d944f..85c8c4b2e 100644 --- a/readme.md +++ b/readme.md @@ -1 +1,20 @@ -Stay tuned! +# Conjure-Oxide + +This repository contains the in progress Conjure Oxide constraints modelling +tool, and it's dependencies. + +This repository hosts the following projects: + +* [Conjure Oxide](https://github.com/conjure-cp/conjure-oxide/tree/main/conjure_oxide) +* [`minion_rs` - Rust bindings to Minion](https://github.com/conjure-cp/conjure-oxide/tree/main/solvers/minion) +* [`chuffed_rs` - Rust bindings to Chuffed](https://github.com/conjure-cp/conjure-oxide/tree/main/solvers/chuffed) + +This project is being produced by staff and students of University of St +Andrews, and is licenced under the [MPL 2.0](./LICENCE). + +## Contributing + +See the [Contributors Guide](https://github.com/conjure-cp/conjure-oxide/wiki/Contributing). + +