docs: fix install instructions to use git clone + uv sync
bincio is not published to PyPI. All CLI invocations use `uv run bincio`.
This commit is contained in:
+12
-12
@@ -4,10 +4,10 @@
|
||||
|
||||
```bash
|
||||
# 1. Drop new .fit / .gpx / .tcx files into your input dir, then:
|
||||
bincio extract
|
||||
uv run bincio extract
|
||||
|
||||
# 2. Rebuild the site (merges any sidecar edits, then builds)
|
||||
bincio render
|
||||
uv run bincio render
|
||||
|
||||
# 3. Done — copy site/dist/ to your host
|
||||
```
|
||||
@@ -17,24 +17,24 @@ bincio render
|
||||
## Extract
|
||||
|
||||
```bash
|
||||
bincio extract # full run using extract_config.yaml
|
||||
bincio extract --since 2025-01-01 # only files newer than date
|
||||
bincio extract --file ride.gpx # single file → JSON on stdout
|
||||
bincio extract --input ~/rides \
|
||||
--output ~/bincio_data # override config paths
|
||||
uv run bincio extract # full run using extract_config.yaml
|
||||
uv run bincio extract --since 2025-01-01 # only files newer than date
|
||||
uv run bincio extract --file ride.gpx # single file → JSON on stdout
|
||||
uv run bincio extract --input ~/rides \
|
||||
--output ~/bincio_data # override config paths
|
||||
```
|
||||
|
||||
Re-extraction is safe — unchanged files are skipped (hash-based dedup).
|
||||
To force a full re-extract: `rm -rf ~/bincio_data && bincio extract`
|
||||
To force a full re-extract: `rm -rf ~/bincio_data && uv run bincio extract`
|
||||
|
||||
---
|
||||
|
||||
## Render
|
||||
|
||||
```bash
|
||||
bincio render # merge edits + production build → site/dist/
|
||||
bincio render --serve # merge edits + dev server → http://localhost:4321
|
||||
bincio render --data-dir ~/bincio_data # explicit data dir
|
||||
uv run bincio render # merge edits + production build → site/dist/
|
||||
uv run bincio render --serve # merge edits + dev server → http://localhost:4321
|
||||
uv run bincio render --data-dir ~/bincio_data # explicit data dir
|
||||
```
|
||||
|
||||
`bincio render` always runs `merge_all()` first (applies sidecar edits, produces `_merged/`),
|
||||
@@ -52,7 +52,7 @@ npm run preview
|
||||
|
||||
```bash
|
||||
# Start the edit server (port 4041 by default)
|
||||
bincio edit --data-dir ~/bincio_data
|
||||
uv run bincio edit --data-dir ~/bincio_data
|
||||
|
||||
# Set PUBLIC_EDIT_URL=http://localhost:4041 in site/.env to enable the Edit button
|
||||
# Then browse to any activity and click Edit — a drawer opens in the same page
|
||||
|
||||
Reference in New Issue
Block a user