summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md42
1 files changed, 41 insertions, 1 deletions
diff --git a/README.md b/README.md
index 1f10505..d0ae877 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,43 @@
# FastForge
-WIP - Come back later.
+FastForge is a Pebble watchapp for intermittent fasting tracking, built with the Rebble SDK.
+
+## Day-1 Setup (Fedora + Rebble SDK 4.9+)
+
+```bash
+sudo dnf update
+sudo dnf install -y python3-pip nodejs SDL-devel dtc uv just
+uv tool install pebble-tool --python 3.13
+pebble sdk install latest
+```
+
+## After Reboot
+
+```bash
+export PATH="$HOME/.local/bin:$PATH"
+pebble --version
+```
+
+## Development Workflow
+
+```bash
+cd /home/paul/git/fastforge
+just dev
+```
+
+In a second terminal:
+
+```bash
+cd /home/paul/git/fastforge
+export PATH="$HOME/.local/bin:$PATH"
+just logs
+```
+
+Useful commands:
+
+- `just`: list commands
+- `just dev`: build + install to basalt emulator
+- `just logs`: live logs from basalt emulator
+- `just screenshot`: screenshot from basalt emulator
+- `just kill`: stop emulator
+- `just clean`: remove build artifacts