Skip to content
This repository has been archived by the owner on Jun 15, 2024. It is now read-only.

Commit

Permalink
docs: Update install instruction
Browse files Browse the repository at this point in the history
  • Loading branch information
doomspec committed Feb 5, 2024
1 parent 121bbcd commit 9092541
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 5 deletions.
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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.
3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down

0 comments on commit 9092541

Please sign in to comment.