Skip to content

Commit

Permalink
chore: improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
TendTo committed Oct 21, 2024
1 parent 6e3e387 commit 734e014
Showing 1 changed file with 8 additions and 13 deletions.
21 changes: 8 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Dlinear
# <img alt="Icon" src="docs/_static/logo.svg" align="left" width="35" height="35"> Dlinear

[![dlinear CI](https://github.com/TendTo/dlinear/actions/workflows/dlinear.yml/badge.svg)](https://github.com/TendTo/dlinear/actions/workflows/dlinear.yml)
[![Docker CI](https://github.com/TendTo/dlinear/actions/workflows/docker.yml/badge.svg)](https://github.com/TendTo/dlinear/actions/workflows/docker.yml)
[![Docker CI](https://github.com/TendTo/dlinear/actions/workflows/docker.yml/badge.svg)](https://github.com/TendTo/dlinear/pkgs/container/dlinear)
[![Docs CI](https://github.com/TendTo/dlinear/actions/workflows/docs.yml/badge.svg)](https://tendto.github.io/dlinear/)
[![pydlinear CI](https://github.com/TendTo/dlinear/actions/workflows/pydlinear.yml/badge.svg)](https://github.com/TendTo/dlinear/actions/workflows/pydlinear.yml)
[![pydlinear CI](https://github.com/TendTo/dlinear/actions/workflows/pydlinear.yml/badge.svg)](https://pypi.org/project/pydlinear)

Delta-complete SMT solver for linear theories over the reals.
Fork of [dlinear4](https://github.com/martinjos/dlinear4) and [dReal4](https://github.com/dreal/dreal4).
Expand All @@ -19,28 +19,23 @@ The recommanded approach is to use the official [Docker image](https://github.co
```bash
# Docker
docker pull ghcr.io/tendto/dlinear:main
# Run dlinear
docker run -it --rm ghcr.io/tendto/dlinear:main --help
```

```bash
# ppa repository
sudo add-apt-repository ppa:tendto/dlinear
sudo apt update
# Run dlinear
dlinear --help
```

```bash
# pydlinear
pip3 install pydlinear
# Run dlinear
pydlinear --help
```

For more information about the installation process options, including installation from sources, refer to the [installation guide](docs/Installation.md).

### Usage

For more information, refer to the [usage guide](docs/Usage.md).

```bash
dlinear --help
# Use `pydlinear --help` if you installed the pydlinear wrapper
```
For more information about the setup, including installation from sources, refer to the [installation guide](docs/Installation.md) and [usage guide](docs/Usage.md)

0 comments on commit 734e014

Please sign in to comment.