docs + chore(workplan): complete T06 and T07 for CYA-WP-0004 — final documentation polish and packaging debt registration

This commit is contained in:
2026-05-27 00:18:39 +02:00
parent 69de28b1fe
commit c0039c293a
3 changed files with 68 additions and 57 deletions

View File

@@ -20,59 +20,42 @@ usable after `pip install -e .`:
## Installation
### Recommended: Install from Development Head (Latest Code)
### 1. Install from Development Head (Recommended for Daily Use)
This is the easiest way to stay on the absolute latest version while you work:
Stay on the absolute latest code with one command:
```bash
git clone https://github.com/worsch/can-you-assist.git
cd can-you-assist
# One-command developer install (includes dev tools)
make dev-install
# Or manually:
# pip install -e ".[dev]"
```
This installs the package in editable mode from your local checkout. You will always get the newest code when you pull.
After installation:
```bash
cya --help
cya --version # Will show a development version (e.g. 0.2.0.devN+g...)
```
### Alternative: Install Directly from Git (No Local Clone)
You can also install the latest code directly from GitHub without cloning first:
Or the direct git method (no permanent clone needed):
```bash
pip install "git+https://github.com/worsch/can-you-assist.git@main#egg=can-you-assist[dev]"
```
This is useful for quick testing or on remote machines.
After installing, `cya --version` will show a development version (e.g. `0.2.0.dev48+gf500a35...`).
### For Future Released Versions
### 2. Install a Released Version (Future)
Once we publish packages (future work), you will be able to do:
Once we publish official releases:
```bash
pip install can-you-assist
```
or a specific version:
```bash
# or a specific version
pip install "can-you-assist>=0.3.0"
```
### Updating to Latest Development Code
See `docs/release-process.md` for how releases are cut.
### Updating
```bash
cd can-you-assist
git pull
pip install -e ".[dev]" # or just `make dev-install`
make dev-install
```
## Usage examples