diff options
| author | twells46 <tom@wellsth.com> | 2026-03-07 09:17:59 -0600 |
|---|---|---|
| committer | twells46 <tom@wellsth.com> | 2026-03-07 09:17:59 -0600 |
| commit | 6c7fa74e6564260448c36115a99c7f01abc76b56 (patch) | |
| tree | 9299decfeac41260280a9fdb1ce1b2d6667cdb5e /README.md | |
| parent | d2b6b3060cfbeb17047f1fd1f989677f28f677eb (diff) | |
Update README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 9 |
1 files changed, 7 insertions, 2 deletions
@@ -2,11 +2,16 @@ Step onto the `porch` and see the weather! +## Building + +Use either `go build` or `make` in the project root. +The default `make` target strips debug info, producing a slightly smaller binary -- 7.1 MB vs 10.2 MB on my `musl` system. + ## Usage First, place your OpenWeatherMap API key in `~/.config/porch/key.txt`. -You can get one for free [here](https://openweathermap.org/). -If you wish, you can place your home city in `~/.config/porch/defaultCity.txt`. +OpenWeatherMap offers a free API plan with very generous limits; you can get started [here](https://openweathermap.org/). +If you wish, you can also place your home city in `~/.config/porch/defaultCity.txt`. To get weather for your default city (if set), run: |