Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
karmacoma-eth authored Aug 14, 2024
1 parent f5acded commit 4a31b9a
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,22 @@ Join the [Halmos Telegram Group][chat] for any inquiries or further discussions.

## Installation

```
```sh
pip install halmos
```

Or, if you want to try out the nightly build version:
```

```sh
pip install git+https://github.com/a16z/halmos
```

Alternatively, you can download the Docker image that contains halmos and its dependencies:

```sh
docker pull .:/workspace ghcr.io/a16z/halmos:0.1.14
```

## Usage

```
Expand All @@ -31,10 +38,20 @@ halmos
```

For more details:

```
halmos --help
```

Alternatively, you can run the latest halmos Docker image available at [ghcr.io/a16z/halmos](ghcr.io/a16z/halmos):

```sh
cd /path/to/src

# mount '.' under /workspace in the container
docker run -v .:/workspace ghcr.io/a16z/halmos:0.1.14
```

## Examples

Refer to the [getting started guide](docs/getting-started.md) and the [examples](examples/README.md) directory.
Expand Down

0 comments on commit 4a31b9a

Please sign in to comment.