improve software doc structure
This commit is contained in:
parent
83d472ed33
commit
89b91d2365
|
@ -41,7 +41,12 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"group": "Software Setup",
|
"group": "Software Setup",
|
||||||
"pages": ["software/installation", "software/setup", "software/flags"]
|
"pages": [
|
||||||
|
"software/installation",
|
||||||
|
"software/run",
|
||||||
|
"software/configure",
|
||||||
|
"software/flags"
|
||||||
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"group": "Hardware Setup",
|
"group": "Hardware Setup",
|
||||||
|
|
|
@ -1,16 +1,8 @@
|
||||||
---
|
---
|
||||||
title: "Setup"
|
title: "Configure"
|
||||||
description: "Get your 01 server up and running"
|
description: "Configure your 01 instance"
|
||||||
---
|
---
|
||||||
|
|
||||||
## Run Server
|
|
||||||
|
|
||||||
```bash
|
|
||||||
poetry run 01 --server
|
|
||||||
```
|
|
||||||
|
|
||||||
## Configure
|
|
||||||
|
|
||||||
A core part of the 01 server is the interpreter which is an instance of Open Interpreter.
|
A core part of the 01 server is the interpreter which is an instance of Open Interpreter.
|
||||||
Open Interpreter is highly configurable and only requires updating a single file.
|
Open Interpreter is highly configurable and only requires updating a single file.
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
---
|
---
|
||||||
title: "Flags"
|
title: "Flags"
|
||||||
description: "Customize the behaviour of your 01"
|
description: "Customize the behaviour of your 01 from the CLI"
|
||||||
---
|
---
|
||||||
|
|
||||||
## CLI Flags
|
## CLI Flags
|
||||||
|
|
|
@ -28,14 +28,4 @@ Install your project along with its dependencies in a virtual environment manage
|
||||||
poetry install
|
poetry install
|
||||||
```
|
```
|
||||||
|
|
||||||
Run your local version of 01 with:
|
Now you should be ready to [run your 01](/software/run)
|
||||||
|
|
||||||
```bash
|
|
||||||
poetry run 01
|
|
||||||
```
|
|
||||||
|
|
||||||
Use 01 with your <a href="/hardware/01-light">01 Light</a>
|
|
||||||
|
|
||||||
```bash
|
|
||||||
poetry run 01 --server
|
|
||||||
```
|
|
||||||
|
|
|
@ -0,0 +1,18 @@
|
||||||
|
---
|
||||||
|
title: "Run"
|
||||||
|
description: "Run your 01"
|
||||||
|
---
|
||||||
|
|
||||||
|
<Info> Make sure that you have navigated to the `software` directory. </Info>
|
||||||
|
|
||||||
|
To run 01 with your computer's microphone and speaker, run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
poetry run 01
|
||||||
|
```
|
||||||
|
|
||||||
|
To use 01 with your <a href="/hardware/01-light">01 Light</a>, run the server:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
poetry run 01 --server
|
||||||
|
```
|
Loading…
Reference in New Issue