Skip to content

Commit 5c4a9c9

Browse files
committed
chore: updated README with dev section
Refs: OthersideAI#155
1 parent 0d9796c commit 5c4a9c9

File tree

1 file changed

+34
-30
lines changed

1 file changed

+34
-30
lines changed

README.md

+34-30
Original file line numberDiff line numberDiff line change
@@ -40,48 +40,52 @@ If you're interested in gaining access to this API, sign up [here](https://other
4040

4141
1. **Install the project**
4242

43-
```
44-
pip install self-operating-computer
45-
```
43+
```bash
44+
pip install self-operating-computer
45+
```
4646

4747
2. **Run the project**
4848

49-
```
50-
operate
51-
```
49+
```bash
50+
operate
51+
```
5252

5353
3. **Enter your OpenAI Key**: If you don't have one, you can obtain an OpenAI key [here](https://platform.openai.com/account/api-keys)
5454
55-
<div align="center">
56-
<img src="https://github.com/OthersideAI/self-operating-computer/blob/main/readme/key.png" width="300" style="margin: 10px;"/>
57-
</div>
55+
<div align="center">
56+
<img src="https://github.com/OthersideAI/self-operating-computer/blob/main/readme/key.png" width="300" style="margin: 10px;"/>
57+
</div>
5858
5959
4. **Give Terminal app the required permissions**: 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".
6060

61-
<div align="center">
62-
<img src="https://github.com/OthersideAI/self-operating-computer/blob/main/readme/terminal-access-1.png" width="300" style="margin: 10px;"/>
63-
<img src="https://github.com/OthersideAI/self-operating-computer/blob/main/readme/terminal-access-2.png" width="300" style="margin: 10px;"/>
64-
</div>
61+
<div align="center">
62+
<img src="https://github.com/OthersideAI/self-operating-computer/blob/main/readme/terminal-access-1.png" width="300" style="margin: 10px;"/>
63+
<img src="https://github.com/OthersideAI/self-operating-computer/blob/main/readme/terminal-access-2.png" width="300" style="margin: 10px;"/>
64+
</div>
6565

6666
### Alternatively installation with `.sh`
6767

6868
1. **Clone the repo** to a directory on your computer:
6969

70-
```
71-
git clone https://github.com/OthersideAI/self-operating-computer.git
72-
```
70+
```bash
71+
git clone https://github.com/OthersideAI/self-operating-computer.git
72+
```
7373

7474
2. **Cd into directory**:
7575

76-
```
77-
cd self-operating-computer
78-
```
76+
```bash
77+
cd self-operating-computer
78+
```
7979

8080
3. **Run the installation script**:
8181

82-
```
83-
./run.sh
84-
```
82+
```bash
83+
./run.sh
84+
```
85+
86+
## Development
87+
88+
We use [PDM](https://pdm-project.org/latest/) as our package and dependency manager. You can find instructions for insallation and usage [here](https://pdm-project.org/latest/#recommended-installation-method).
8589

8690
## Using `operate` Modes
8791

@@ -91,7 +95,7 @@ An additional model is now compatible with the Self Operating Computer Framework
9195
9296
Start `operate` with the Gemini model
9397
94-
```
98+
```bash
9599
operate -m gemini-pro-vision
96100
```
97101
@@ -115,7 +119,7 @@ For this initial version, a simple YOLOv8 model is trained for button detection,
115119

116120
Start `operate` with the SoM model
117121

118-
```
122+
```bash
119123
operate -m gpt-4-with-som
120124
```
121125

@@ -124,38 +128,38 @@ operate -m gpt-4-with-som
124128
The framework supports voice inputs for the objective. Try voice by following the instructions below.
125129
**Clone the repo** to a directory on your computer:
126130

127-
```
131+
```bash
128132
git clone https://github.com/OthersideAI/self-operating-computer.git
129133
```
130134

131135
**Cd into directory**:
132136

133-
```
137+
```bash
134138
cd self-operating-computer
135139
```
136140

137141
Install the additional `requirements-audio.txt`
138142

139-
```
143+
```bash
140144
pip install -r requirements-audio.txt
141145
```
142146

143147
**Install device requirements**
144148
For mac users:
145149

146-
```
150+
```bash
147151
brew install portaudio
148152
```
149153

150154
For Linux users:
151155

152-
```
156+
```bash
153157
sudo apt install portaudio19-dev python3-pyaudio
154158
```
155159

156160
Run with voice mode
157161

158-
```
162+
```bash
159163
operate --voice
160164
```
161165

0 commit comments

Comments
 (0)