Documentation

This commit is contained in:
Brandon Thomas
2023-08-30 18:56:40 -04:00
parent 0d15c263b7
commit fd754a7151
6 changed files with 40 additions and 0 deletions
+1
View File
@@ -56,3 +56,4 @@ storyteller-ml
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠈⠉⠛⠶⠦⣤⡷⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
```
User documentation [lives here](_docs/)

Before

Width:  |  Height:  |  Size: 79 KiB

After

Width:  |  Height:  |  Size: 79 KiB

Before

Width:  |  Height:  |  Size: 98 KiB

After

Width:  |  Height:  |  Size: 98 KiB

Before

Width:  |  Height:  |  Size: 105 KiB

After

Width:  |  Height:  |  Size: 105 KiB

+39
View File
@@ -0,0 +1,39 @@
local development setup
=======================
Ubuntu 22.04
------------
### Install Python
```bash
sudo apt install python3.11-venv
```
### Install Docker
```bash
sudo apt install docker.io
# Docker requires user group permissions
# This may require a logout to work
sudo groupadd docker
sudo usermod -aG docker ${USER}
newgrp docker
# Test if Docker works
docker run hello-world
```
MacOS
-----
(TODO)
Windows
-------
(Not supported.)