2.0 KiB

Raw Blame History

○

Official pre-release repository for The 01 Project.

11 days remaining until launch

View task list ↗

Install dependencies:

# MacOS
brew install portaudio ffmpeg

# Ubuntu
sudo apt-get install portaudio19-dev ffmpeg

Setup for usage (experimental):

pip install 01OS

Run the 01 end-to-end:

01 # This will run a server + attempt to determine and run a client.
# (Behavior can be modified by changing the contents of `.env`)

Expose an 01 server publically:

01 --server --expose # This will print a URL that a client can point to.

Run a specific client:

01 --client macos # Options: macos, rpi

Run locally:

The current default uses OpenAI's services.

The --local flag will install and run the whisper.cpp STT and Piper TTS models.

01 --local # Local client and server
01 --local --server --expose # Expose a local server

Setup for development:

# Clone the repo, cd into the 01OS directory
git clone https://github.com/KillianLucas/01.git
cd 01OS

# Install dependencies, run the commands above
poetry install
poetry run 01

Configuration:

Copy the 01OS/.env.example file to 01OS/.env then configure the environment variables within the file.

Background

Context ↗

The story of devices that came before the 01.

Inspiration ↗

Things we want to steal great ideas from.

Direction

Goals ↗

What we're going to do.

Use Cases ↗

What the 01 will be able to do.

2.0 KiB Raw Blame History

○