Skip to content

Commit b9f720d

Browse files
authored
Merge pull request #203 from dheavy/feat/update-docs-win-install
Update documentation for Windows installation
2 parents 30774b3 + 4901a4e commit b9f720d

File tree

3 files changed

+29
-7
lines changed

3 files changed

+29
-7
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ export OPENAI_API_KEY=sk... # OR run `poetry run 01 --local` to run everything l
4848
poetry run 01 # Runs the 01 Light simulator (hold your spacebar, speak, release)
4949
```
5050

51+
<!-- > For a Windows installation, read our [setup guide](https://docs.openinterpreter.com/getting-started/setup#windows). -->
52+
5153
<br>
5254

5355
# Hardware

docs/getting-started/introduction.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: Introduction
3-
description: "The open-source language model computer."
3+
description: 'The open-source language model computer.'
44
---
55

66
<img
77
src="https://www.openinterpreter.com/OI-O1-BannerDemo-3.jpg"
88
alt="thumbnail"
9-
style={{ transform: "translateY(-1.25rem)" }}
9+
style={{ transform: 'translateY(-1.25rem)' }}
1010
/>
1111

1212
The 01 project is an open-source ecosystem for artificially intelligent devices.
@@ -27,6 +27,8 @@ brew install portaudio ffmpeg cmake
2727
sudo apt-get install portaudio19-dev ffmpeg cmake
2828
```
2929

30+
For windows, please refer to the [setup guide](/getting-started/setup#windows).
31+
3032
### Install and run the 01 CLI
3133

3234
```bash

docs/getting-started/setup.mdx

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: "Setup"
3-
description: "Get your 01 up and running"
2+
title: 'Setup'
3+
description: 'Get your 01 up and running'
44
---
55

66
## Captive portal
@@ -25,6 +25,24 @@ brew install portaudio ffmpeg cmake
2525

2626
# Ubuntu
2727
sudo apt-get install portaudio19-dev ffmpeg cmake
28+
29+
# Install poetry
30+
curl -sSL https://install.python-poetry.org | python3 -
31+
```
32+
33+
#### Windows
34+
35+
On Windows you will need to install the following:
36+
37+
- [Git for Windows](https://git-scm.com/download/win).
38+
- [virtualenv](https://virtualenv.pypa.io/en/latest/installation.html) or [MiniConda](https://docs.anaconda.com/free/miniconda/miniconda-install/) to manage virtual environments.
39+
- [Chocolatey](https://chocolatey.org/install#individual) to install the required packages.
40+
41+
With these installed, you can run the following commands in a **PowerShell terminal as an administrator**:
42+
43+
```powershell
44+
# Install the required packages
45+
choco install -y ffmpeg cmake
2846
```
2947

3048
## Install 01
@@ -38,7 +56,7 @@ git clone https://github.com/OpenInterpreter/01.git
3856

3957
## Run the 01
4058

41-
In order to run 01 on your computer, use [Poetry](https://python-poetry.org/docs/#installing-with-the-official-installer)
59+
In order to run 01 on your computer, use [Poetry](https://python-poetry.org/docs/#installing-with-the-official-installer).
4260

4361
Navigate to the project's software directory:
4462

@@ -64,8 +82,8 @@ You have the ability to set your <a href="/services/language-model">LLM</a>, <a
6482

6583
## Server setup
6684

67-
You are able to run just the <a href="/server/setup">server</a>
85+
You are able to run just the <a href="/server/setup">server</a>.
6886

6987
## Client setup
7088

71-
You are able to run just the <a href="/client/setup">client</a>
89+
You are able to run just the <a href="/client/setup">client</a>.

0 commit comments

Comments
 (0)