Skip to content

Commit

Permalink
Merge pull request trueagi-io#689 from trueagi-io/update-readme
Browse files Browse the repository at this point in the history
Add section on using release from PyPi
  • Loading branch information
vsbogd authored May 9, 2024
2 parents e7c42b6 + cfd81f6 commit 476042e
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,15 @@ If you want to contribute the project please see the [contribution guide](./docs
If you find troubles with the installation, see the [Troubleshooting](#troubleshooting) section below.
For development related instructions see the [development guide](./docs/DEVELOPMENT.md).

# Prepare environment
# Using the latest release version

It is the most simple way of getting MeTTa interpreter especially if you are a Python developer.
The following command installs the latest release version from PyPi package repository:
```
python3 -m pip install hyperon
```

# Prepare development environment

## Docker

Expand All @@ -27,6 +35,17 @@ environment. Please keep in mind that resulting image contains temporary build
files and takes a lot of a disk space. It is not recommended to distribute it
as an image for running MeTTa because of its size.

### Ready to use image

Run latest docker image from the Dockerhub:
```
docker run -ti trueagi/hyperon:latest
```

### Build image

Docker 26.0.0 or greater version is required.

Build Docker image from a local copy of the repo running:
```
docker build -t trueagi/hyperon .
Expand Down

0 comments on commit 476042e

Please sign in to comment.