Skip to content

Commit d4e9c06

Browse files
authored
Document Homebrew install, reorganize README, and check it against the binary (#62)
* Document Homebrew install and reorganize README install section * Say which install methods cover which platforms * Restore the sixth target and PowerShell note lost in the rewrite * Reorganize README around what a reader does first * Check README's commands against the binary The README listed four API groups (rasterarrays, static-images, static-tiles, tilequery) the binary no longer has, and never mentioned doctor, usage or the real static group. Nothing read the README, so nobody noticed. * Fix README's command list and cut detail docs/commands.md already has
1 parent 029f5b9 commit d4e9c06

4 files changed

Lines changed: 330 additions & 187 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,10 @@ and not a style note.
3939
and a fake server, so the suite runs offline and on a machine that has never
4040
logged in.
4141

42+
`scripts/test-install.sh` and `scripts/test-install.ps1` exercise the
43+
installers end to end without touching the network, and
44+
`scripts/test-completion.sh` does the same for the completion scripts.
45+
4246
Four rules the compiler holds rather than a reviewer, declared in
4347
`Cargo.toml` with the reasoning beside each: no `unsafe`, no `println!`
4448
(stdout belongs to `output::emit`, the single place `--output` is honored),

0 commit comments

Comments
 (0)