From 4901a4e36f72d5d54ac3619907bc6d7226c16eae Mon Sep 17 00:00:00 2001
From: Davy Peter Braun <543614+dheavy@users.noreply.github.com>
Date: Sun, 31 Mar 2024 22:05:28 +0200
Subject: [PATCH] Update documentation for Windows installation
---
README.md | 2 ++
docs/getting-started/introduction.mdx | 6 ++++--
docs/getting-started/setup.mdx | 28 ++++++++++++++++++++++-----
3 files changed, 29 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
index 298d0989..291174fe 100644
--- a/README.md
+++ b/README.md
@@ -48,6 +48,8 @@ export OPENAI_API_KEY=sk... # OR run `poetry run 01 --local` to run everything l
poetry run 01 # Runs the 01 Light simulator (hold your spacebar, speak, release)
```
+
+
# Hardware
diff --git a/docs/getting-started/introduction.mdx b/docs/getting-started/introduction.mdx
index 3bd1ca5d..1b14e3a9 100644
--- a/docs/getting-started/introduction.mdx
+++ b/docs/getting-started/introduction.mdx
@@ -1,12 +1,12 @@
---
title: Introduction
-description: "The open-source language model computer."
+description: 'The open-source language model computer.'
---
The 01 project is an open-source ecosystem for artificially intelligent devices.
@@ -27,6 +27,8 @@ brew install portaudio ffmpeg cmake
sudo apt-get install portaudio19-dev ffmpeg cmake
```
+For windows, please refer to the [setup guide](/getting-started/setup#windows).
+
### Install and run the 01 CLI
```bash
diff --git a/docs/getting-started/setup.mdx b/docs/getting-started/setup.mdx
index 59dc4636..92cc8144 100644
--- a/docs/getting-started/setup.mdx
+++ b/docs/getting-started/setup.mdx
@@ -1,6 +1,6 @@
---
-title: "Setup"
-description: "Get your 01 up and running"
+title: 'Setup'
+description: 'Get your 01 up and running'
---
## Captive portal
@@ -25,6 +25,24 @@ brew install portaudio ffmpeg cmake
# Ubuntu
sudo apt-get install portaudio19-dev ffmpeg cmake
+
+# Install poetry
+curl -sSL https://install.python-poetry.org | python3 -
+```
+
+#### Windows
+
+On Windows you will need to install the following:
+
+- [Git for Windows](https://git-scm.com/download/win).
+- [virtualenv](https://virtualenv.pypa.io/en/latest/installation.html) or [MiniConda](https://docs.anaconda.com/free/miniconda/miniconda-install/) to manage virtual environments.
+- [Chocolatey](https://chocolatey.org/install#individual) to install the required packages.
+
+With these installed, you can run the following commands in a **PowerShell terminal as an administrator**:
+
+```powershell
+# Install the required packages
+choco install -y ffmpeg cmake
```
## Install 01
@@ -38,7 +56,7 @@ git clone https://github.com/OpenInterpreter/01.git
## Run the 01
-In order to run 01 on your computer, use [Poetry](https://python-poetry.org/docs/#installing-with-the-official-installer)
+In order to run 01 on your computer, use [Poetry](https://python-poetry.org/docs/#installing-with-the-official-installer).
Navigate to the project's software directory:
@@ -64,8 +82,8 @@ You have the ability to set your LLM, server
+You are able to run just the server.
## Client setup
-You are able to run just the client
+You are able to run just the client.