From 4087f1b5d93e7df8937b2d7a7e6b3091fddd59f4 Mon Sep 17 00:00:00 2001 From: Ryan Miller Date: Sat, 7 Sep 2024 11:45:03 +1000 Subject: [PATCH] chore: merge readme pre-requisites sections --- README.md | 19 +++++-------------- 1 file changed, 5 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 6427833..1b00a47 100644 --- a/README.md +++ b/README.md @@ -4,18 +4,15 @@ ### Pre-requisites - apt install build-essential python3-dev python3-flask - - python3 -m pip install eth_utils web3 +The `liboxenc-dev` and `liboxenmq-dev` packages require the development headers by setting up the +[Oxen Deb Repository](https://deb.oxen.io). Follow those instructions then they can be installed with `apt`. To run the backend on **Ubuntu >= 24.04**: ```shell -apt install build-essential python3-pip python3-dev pybind11-dev liboxenc-dev liboxenmq-dev python3.12-venv -pip install eth_utils web3 PyNaCl Flask uWSGI +apt install build-essential python3-pip python3-dev pybind11-dev liboxenc-dev liboxenmq-dev +python3 -m pip install eth_utils web3 PyNaCl Flask uWSGI ``` -Additionally, you need: - **Python bindings for oxen-mq & oxen-encoding** Instructions available at: @@ -23,17 +20,11 @@ Instructions available at: - [oxen-pyoxenc](https://github.com/oxen-io/oxen-pyoxenc) - [oxen-pyoxenmq](https://github.com/oxen-io/oxen-pyoxenmq) -These packages require the development headers by setting up the -[Oxen Deb Repository](https://deb.oxen.io). Follow those instructions and then -install the following packages - - apt install liboxenc-dev liboxenmq-dev +### Instance Before running an instance, `oxend` must be running and its address/smart contracts configured in `config.py`. -### Instance - It's possible to run the service in flask directly but the timers to poll the smart contracts requires WSGI. Both methods are detailed below: