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:
Davide Scaini
2026-03-29 16:26:13 +02:00
parent f73b4c84e5
commit d2149bf77a
2 changed files with 22 additions and 20 deletions
+10 -8
View File
@@ -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
```