From d2149bf77a6dbc7ae3302e91b0d7ac14f6ca6e1c Mon Sep 17 00:00:00 2001 From: Davide Scaini Date: Sun, 29 Mar 2026 16:26:13 +0200 Subject: [PATCH] docs: fix install instructions to use git clone + uv sync bincio is not published to PyPI. All CLI invocations use `uv run bincio`. --- CHEATSHEET.md | 24 ++++++++++++------------ README.md | 18 ++++++++++-------- 2 files changed, 22 insertions(+), 20 deletions(-) diff --git a/CHEATSHEET.md b/CHEATSHEET.md index 0983e5c..ff332dd 100644 --- a/CHEATSHEET.md +++ b/CHEATSHEET.md @@ -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 diff --git a/README.md b/README.md index 1d3a56d..017c7bb 100644 --- a/README.md +++ b/README.md @@ -35,30 +35,32 @@ Everything in `~/bincio_data/` is plain text you can read, edit, back up, or pub ## Quick start ```bash -# 1. Install Python package -pip install bincio # or: uv add bincio +# 1. Clone and install (requires Python >= 3.12 and uv) +git clone https://github.com/brutsalvadi/bincio-activity.git +cd bincio-activity +uv sync # installs the bincio package + all dependencies # 2. Configure cp extract_config.example.yaml extract_config.yaml $EDITOR extract_config.yaml # set input dirs, output dir, your name # 3. Extract activities → BAS JSON -bincio extract +uv run bincio extract # 4. Build the site (requires Node >= 20) -cd site && npm install -cp .env.example .env # configure BINCIO_DATA_DIR -bincio render # merges edits + runs astro build +cd site && npm install && cd .. +cp site/.env.example site/.env # configure BINCIO_DATA_DIR +uv run bincio render # merges edits + runs astro build # → open site/dist/index.html ``` For live development with hot reload: ```bash -bincio render --serve # merges edits, links data, starts astro dev +uv run bincio render --serve # merges edits, links data, starts astro dev # → http://localhost:4321 # Optional: enable the activity edit UI -bincio edit # starts edit server on http://localhost:4041 +uv run bincio edit # starts edit server on http://localhost:4041 # Set PUBLIC_EDIT_URL=http://localhost:4041 in site/.env ```