From 90925412b02d15425a83dd762f3a7efe2c33e192 Mon Sep 17 00:00:00 2001 From: Zijian Zhang Date: Mon, 5 Feb 2024 01:58:50 -0500 Subject: [PATCH] docs: Update install instruction --- README.md | 22 ++++++++++++++++++---- pyproject.toml | 3 ++- 2 files changed, 20 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 616da40..8604dc6 100644 --- a/README.md +++ b/README.md @@ -22,14 +22,14 @@ conda install nodejs You can set up your development environment by the following steps. ```shell -mkdir EvoEvolver +conda create -n Evo python=3.10 +conda activate Evo # You can replace the name +conda install nodejs # if you haven't installed it +mkdir EvoEvolver # Create the folder for the projects cd EvoEvolver git clone https://github.com/EvoEvolver/Fibers.git git clone https://github.com/EvoEvolver/Moduler.git git clone https://github.com/EvoEvolver/Forest.git -cd Forest -npm install -cd .. ``` If you are using PyCharm, do the following steps: @@ -44,6 +44,20 @@ pip install -e Forest pip install -e Fibers ``` +Add your OpenAI API key to the environment variables. You can do this by adding the following line to your `.bashrc` or `.zshrc` file. Remember to replace `your_api_key` with your actual API key starting with `sk-`. + + +For Linux: +```shell +echo "export OPENAI_API_KEY='your_api_key'" >> ~/.bashrc +``` + +For MacOS: +```shell +echo "export OPENAI_API_KEY='your_api_key'" >> ~/.zshrc +``` + + ## Acknowledgement This project is led by [the matter lab](https://www.matter.toronto.edu/) at the University of Toronto. \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index 11179ae..8961379 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -28,7 +28,8 @@ dependencies = [ "Flask==3.0.0", "Flask-SocketIO==5.3.6", "Werkzeug==3.0.1", - "simple-websocket==1.0.0" + "simple-websocket==1.0.0", + "pillow" ] [project.optional-dependencies]