Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sthiele committed Oct 4, 2023
1 parent 59f3ca5 commit 3267229
Showing 1 changed file with 15 additions and 8 deletions.
23 changes: 15 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,10 @@
# clingo-rs [![Build Status](https://travis-ci.org/potassco/clingo-rs.svg?branch=master)](https://travis-ci.org/potassco/clingo-rs) [![Latest Version](https://img.shields.io/crates/v/clingo.svg)](https://crates.io/crates/clingo) [![Rust Documentation](https://docs.rs/clingo/badge.svg)](https://docs.rs/clingo)

Rust bindings to the [clingo](https://github.com/potassco/clingo) library.
Clingo version 5.5.0.
Clingo version 5.6.2.

## Requirements

- a c++14 conforming compiler
- *at least* [gcc](https://gcc.gnu.org/) version 4.9
- [clang](http://clang.llvm.org/) version 3.1 (using either libstdc++
provided by gcc 4.9 or libc++)

Per default the crate uses the clingo library via dynamic linking.
It is assumed that a clingo dynamic library is installed on the system.
You have to set the environment variable `CLINGO_LIBRARY_PATH`. For example:
Expand Down Expand Up @@ -46,7 +41,7 @@ In your `Cargo.toml` add:

```toml
[dependencies]
clingo = { version = "0.7.2", features = ["derive"] }
clingo = { version = "0.7.3-dev", features = ["derive"] }
```

In your source write:
Expand Down Expand Up @@ -78,9 +73,21 @@ follows.

```toml
[dependencies]
clingo = { version = "0.7.2", features = ["static-linking"] }
clingo = { version = "0.7.3-dev", features = ["static-linking"] }
```

To build clingo for static linking you need the following tools installed:

- a C++14 conforming compiler
- *at least* [GCC](https://gcc.gnu.org/) version 4.9
- [Clang](http://clang.llvm.org/) version 3.1 (using either libstdc++
provided by gcc 4.9 or libc++)
- *at least* MSVC 15.0 ([Visual Studio](https://www.visualstudio.com/) 2017)
- other compilers might work
- the [cmake](https://www.cmake.org/) build system
- at least version 3.18 is recommended
- at least version 3.1 is *required*

## Contribution

[How to make a contribution to `clingo-rs`?](https://github.com/potassco/clingo-rs/blob/master/CONTRIBUTING.md)
Expand Down

0 comments on commit 3267229

Please sign in to comment.