Skip to content

Commit e9bef10

Browse files
committed
Switch back README.md for now
1 parent 47b0581 commit e9bef10

File tree

1 file changed

+31
-10
lines changed

1 file changed

+31
-10
lines changed

README.md

Lines changed: 31 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ We will soon be offering API access to our Agent-1-Vision model.
3333

3434
If you're interested in gaining access to this API, sign up [here](https://othersideai.typeform.com/to/FszaJ1k8?typeform-source=www.hyperwriteai.com).
3535

36+
### Additional Thoughts
37+
We recognize that some operating system functions may be more efficiently executed with hotkeys such as entering the Browser Address bar using `command + L` rather than by simulating a mouse click at the correct XY location. We plan to make these improvements over time. However, it's important to note that many actions require the accurate selection of visual elements on the screen, necessitating precise XY mouse click locations. A primary focus of this project is to refine the accuracy of determining these click locations. We believe this is essential for achieving a fully self-operating computer in the current technological landscape.
3638
## Demo
3739

3840
https://github.com/OthersideAI/self-operating-computer/assets/42594239/9e8abc96-c76a-46fb-9b13-03678b3c67e0
@@ -41,26 +43,45 @@ https://github.com/OthersideAI/self-operating-computer/assets/42594239/9e8abc96-
4143
## Quick Start Instructions
4244
Below are instructions to set up the Self-Operating Computer Framework locally on your computer.
4345

44-
### Option 1: Quick Start
45-
1. **Install the project locally**:
46+
### Option 1: Traditional Installation
47+
48+
1. **Clone the repo** to a directory on your computer:
4649
```
47-
pip install self-operating-computer
50+
git clone https://github.com/OthersideAI/self-operating-computer.git
51+
```
52+
2. **Cd into directory**:
53+
54+
```
55+
cd self-operating-computer
4856
```
49-
2. **Add your Open AI key. If you don't have one, you can obtain an OpenAI key [here](https://platform.openai.com/account/api-keys)**:
5057

51-
For Mac:
58+
3. **Create a Python virtual environment**. [Learn more about Python virtual environment](https://docs.python.org/3/library/venv.html).
59+
60+
```
61+
python3 -m venv venv
62+
```
63+
4. **Activate the virtual environment**:
64+
```
65+
source venv/bin/activate
66+
```
67+
5. **Install Project Requirements and Command-Line Interface: Instead of using `pip install .`, you can now install the project directly from PyPI with:**
5268
```
53-
export OPENAI_API_KEY='your-key-here'
69+
pip install self-operating-computer
70+
```
71+
6. **Then rename the `.example.env` file to `.env` so that you can save your OpenAI key in it.**
72+
```
73+
mv .example.env .env
5474
```
55-
For Windows:
75+
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)**:
5676
```
57-
set GOOGLE_API_KEY='your_api_key'
77+
OPENAI_API_KEY='your-key-here'
5878
```
59-
3. **Run it**!
79+
80+
8. **Run it**!
6081
```
6182
operate
6283
```
63-
5. **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".
84+
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".
6485

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

0 commit comments

Comments
 (0)