Skip to content

Commit 0105586

Browse files
committed
Simplify pip install self-operating-computer install
1 parent edc347c commit 0105586

File tree

1 file changed

+5
-38
lines changed

1 file changed

+5
-38
lines changed

README.md

+5-38
Original file line numberDiff line numberDiff line change
@@ -38,56 +38,23 @@ If you're interested in gaining access to this API, sign up [here](https://other
3838
https://github.com/OthersideAI/self-operating-computer/assets/42594239/9e8abc96-c76a-46fb-9b13-03678b3c67e0
3939

4040

41-
## Quick Start Instructions
42-
Below are instructions to set up the Self-Operating Computer Framework locally on your computer.
43-
44-
### Option 1: Traditional Installation
45-
46-
1. **Clone the repo** to a directory on your computer:
47-
```
48-
git clone https://github.com/OthersideAI/self-operating-computer.git
49-
```
50-
2. **Cd into directory**:
51-
52-
```
53-
cd self-operating-computer
54-
```
55-
56-
3. **Create a Python virtual environment**. [Learn more about Python virtual environment](https://docs.python.org/3/library/venv.html).
57-
58-
```
59-
python3 -m venv venv
60-
```
61-
4. **Activate the virtual environment**:
62-
```
63-
source venv/bin/activate
64-
```
65-
5. **Install Project Requirements and Command-Line Interface: Instead of using `pip install .`, you can now install the project directly from PyPI with:**
41+
## Run `Self-Operating Computer`
42+
Install the project
6643
```
6744
pip install self-operating-computer
6845
```
69-
6. **Then rename the `.example.env` file to `.env` so that you can save your OpenAI key in it.**
70-
```
71-
mv .example.env .env
72-
```
73-
7. **Add your Open AI key to your new `.env` file. If you don't have one, you can obtain an OpenAI key [here](https://platform.openai.com/account/api-keys)**:
74-
```
75-
OPENAI_API_KEY='your-key-here'
76-
```
77-
78-
8. **Run it**!
46+
Next fire the main command
7947
```
8048
operate
8149
```
82-
9. **Final Step**: As a last step, the Terminal app will ask for permission for "Screen Recording" and "Accessibility" in the "Security & Privacy" page of Mac's "System Preferences".
50+
**Final Step**: As a last step, the Terminal app will ask for permission for "Screen Recording" and "Accessibility" in the "Security & Privacy" page of Mac's "System Preferences".
8351

8452
<div align="center">
8553
<img src="https://github.com/OthersideAI/self-operating-computer/blob/main/readme/terminal-access-1.png" width="300" style="margin: 10px;"/>
8654
<img src="https://github.com/OthersideAI/self-operating-computer/blob/main/readme/terminal-access-2.png" width="300" style="margin: 10px;"/>
8755
</div>
8856

89-
90-
### Option 2: Installation using .sh script
57+
### Run with `.sh`
9158

9259
1. **Clone the repo** to a directory on your computer:
9360
```

0 commit comments

Comments
 (0)