diff --git a/README.md b/README.md index 8eb3551aa..76b4ede77 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,6 @@ Pearl is an application used to run autonomous agents powered by the OLAS Networ - Javascript / TypeScript - Python (3.10) - Poetry (^1.7.1) -- Docker Engine ## Getting Started @@ -26,7 +25,7 @@ The following installation steps assume you have the following on each OS:

NodeJS

-NodeJS is best installed and managed through NVM. It allows you to install and select specific versions of NodeJS. Pearl has been built using version 20.11, LTS. +NodeJS is best installed and managed through NVM. It allows you to install and select specific versions of NodeJS. Pearl has been built using version 20 LTS.
Linux
@@ -117,38 +116,6 @@ If promoted to run `pipx ensurepath`, run it.
-

Docker

- -
Linux
- -*Update the `ubuntu.22.04~jammy` version string to your current OS version before running the following command:* - -```bash -VERSION_STRING=5:24.0.7-1~ubuntu.22.04~jammy -sudo apt-get install docker-ce=$VERSION_STRING docker-ce-cli=$VERSION_STRING containerd.io docker-buildx-plugin docker-compose-plugin -sudo usermod -aG docker $USER -``` - -If you are unsure about your current OS version/codename, you can find it by running: - -```bash -lsb_release -a -``` - -
MacOS
- -You can [install Docker Desktop via the Docker website](https://www.docker.com/products/docker-desktop/). Be sure to select the correct version for your system's CPU architecture. - -If you are unsure about your system's CPU architecture, run the following command: - -```bash -uname -p -# x86 64 Intel chip -# arm64 Apple chip -``` - -
-

Setting up your .env file

Create an `.env` file in the root directory, or rename `.env.example` to `.env`. @@ -202,7 +169,7 @@ Provided your system dependencies are installed, environment variables are set, You can start Pearl by running the following command in the root directory: ```bash -yarn start +yarn dev ``` This will run Electron, which launches the NextJS frontend and the Python backend as child processes. @@ -254,9 +221,4 @@ poetry run python scripts/fund.py 0xYOURADDRESS poetry run python scripts/transfer_olas.py PATH_TO_KEY_CONTAINING_OLAS ADDRESS_TO_TRANSFER AMOUNT ``` - - -

Notes and Common Issues

- -- If Pearl is running, it will kill any attempt to run another Pearl instance. This is to ensure there are no port conflicts. -- Enivironment variables are cached in the terminal, if you change them while your terminal is open, you will need to restart the terminal. \ No newline at end of file + \ No newline at end of file