blob: 950014e18722a49133f8bb3a8d071ea514957d7b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
|
# Porch
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`.
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:
```sh
porch
```
To get weather for any city, run:
```sh
porch <city>
```
For example:
```sh
porch New York
```
`porch` can handle spaces in city names.
|
