Skip to content

docs: correct packaging guidance for Trixie #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
joshschmelzle merged 3 commits into from
Oct 22, 2026
Merged

docs: correct packaging guidance for Trixie #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1fa5a00
docs: correct packaging guidance for Trixie
cursoragent Oct 22, 2026
18f2bcc
docs: merge main into packaging guidance
cursoragent Oct 22, 2026
70ecf73
docs: show the wlanpi.us install alias next to the HTTPS one-liner
cursoragent Oct 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion GETTING_STARTED.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,16 @@ This repository contains the documentation for developers who want to contribute
### 1. Install dependencies

```bash
curl -fSL https://raw.githubusercontent.com/WLAN-Pi/developers/main/install.sh | sudo bash
curl -fSL http://wlanpi.us/install | sudo bash
```

That URL is `install.sh` in this repository, fetched over HTTPS.
`http://wlanpi.us/install` is a short alias: a GET redirects to the same
script. The first hop is plain HTTP, because Hover's forwarder is HTTP-only.
The one-liner can move to `https://wlanpi.us/install` once that domain
serves HTTPS, for example with Cloudflare redirect rules or GitHub Pages.

### 2. Set up git

```bash
Expand Down Expand Up @@ -129,13 +136,15 @@ REPO_NAME/
├── debian/ # Debian packaging files
│ ├── control # Package metadata and dependencies
│ ├── changelog # Version history (managed via dch)
│ ├── copyright # DEP-5 copyright
│ ├── rules # Build instructions
│ ├── source/format # 3.0 (native) for first-party packages
│ └── ...
├── wlanpi_yourapp/ # Python package source
├── tests/ # Test files
├── pyproject.toml # Project metadata and tool config
├── requirements.in # Direct dependencies (managed via pip-tools)
├── requirements.txt # Pinned dependencies (generated, do not edit by hand)
├── requirements.txt # Pinned runtime dependencies (generated, do not edit by hand)
├── tox.ini # Tox environments for lint, format, test
├── README.md # Project documentation
└── LICENSE # BSD-3-Clause License
Expand All @@ -145,6 +154,10 @@ This is the target, not a guarantee. Some older repos still use `setup.py`
instead of `pyproject.toml`, or omit `requirements.in`/`tox.ini`. See
[Repository Reference](REPOS.md) for the current state of each repo.

`requirements.txt` is the runtime set that `dh_virtualenv` installs into the
`.deb`. Test tools stay in a `pyproject.toml` extra. See
[Debian Packaging](architecture/PACKAGING.md#runtime-and-test-dependencies).

## Your first contribution

Not sure where to start? Look for issues labeled:
Expand Down
Loading