From d41d46baecb5d71c736540379e0976b282c114ea Mon Sep 17 00:00:00 2001 From: Mike Bird Date: Wed, 20 Mar 2024 13:13:22 -0400 Subject: [PATCH] getting started setup --- docs/getting-started/setup.mdx | 69 +++++++++++++++++++++++++++++++++- 1 file changed, 68 insertions(+), 1 deletion(-) diff --git a/docs/getting-started/setup.mdx b/docs/getting-started/setup.mdx index cbc529b..e9ad18c 100644 --- a/docs/getting-started/setup.mdx +++ b/docs/getting-started/setup.mdx @@ -3,4 +3,71 @@ title: "Setup" description: "Get your 01 up and running" --- -Setup (breaks down the basic steps of the following and links to the pages for more info) +# Hosted 01OS + +## Captive portal + +To connect your 01, you will use the captive portal. + +1. Turn on your computer or laptop and connect to the '01 light' Wi-Fi network. +2. Enter your Wi-Fi/hotspot name and password in the captive portal page. +3. Enter the server URL generated on their computer and hit 'Connect'. + +Now you're connected and ready to go! + +# Local 01OS + +## Prerequisites + +There are a few packages that need to be installed in order to run 01OS on your computer + +```bash +# MacOS +brew install portaudio ffmpeg cmake + +# Ubuntu +sudo apt-get install portaudio19-dev ffmpeg cmake +``` + +## Install 01 + +To install the 01 CLI + +```bash +# Clone the repo and navigate into the 01OS directory +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) + +Navigate to the project's 01OS directory: + +```bash +cd 01OS +``` + +Install your project along with its dependencies in a virtual environment managed by Poetry. + +```bash +poetry install +``` + +Run your local version of 01 with: + +```bash +poetry run 01 +``` + +## Swap out service providers + +You have the ability to set your LLM, STT, and TTS service providers + +## Server setup + +You are able to run just the server + +## Client setup + +You are able to run just the client