Skip to content

Commit

Permalink
Merge pull request #203 from dheavy/feat/update-docs-win-install
Browse files Browse the repository at this point in the history
Update documentation for Windows installation
  • Loading branch information
tyfiero authored Apr 1, 2024
2 parents 30774b3 + 4901a4e commit b9f720d
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 7 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
```

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

<br>

# Hardware
Expand Down
6 changes: 4 additions & 2 deletions docs/getting-started/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: Introduction
description: "The open-source language model computer."
description: 'The open-source language model computer.'
---

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

The 01 project is an open-source ecosystem for artificially intelligent devices.
Expand All @@ -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
Expand Down
28 changes: 23 additions & 5 deletions docs/getting-started/setup.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Setup"
description: "Get your 01 up and running"
title: 'Setup'
description: 'Get your 01 up and running'
---

## Captive portal
Expand All @@ -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
Expand All @@ -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:

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

## Server setup

You are able to run just the <a href="/server/setup">server</a>
You are able to run just the <a href="/server/setup">server</a>.

## Client setup

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

0 comments on commit b9f720d

Please sign in to comment.