Skip to content

Commit

Permalink
Added build info to README.
Browse files Browse the repository at this point in the history
  • Loading branch information
@RRArny
RRArny committed Nov 2, 2024
1 parent 15d3aa3 commit 9604a3f
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,7 @@ If none of the options above are supplied the program defaults to geoip. Positio
## Providing API keys

For wxfetch to work you will need a free account on https://avwx.rest/. Once you have created an account, go ahead and set the environment variable `AVWX_API_KEY` to your API key.

# Building from source

Wxfetch is written in Rust. In order to build it, run `cargo build` for a debug build, for a production build run `cargo build --release`. This will generate a binary file within the `target` directory in the `debug` and `release` subdirectories respectively.

0 comments on commit 9604a3f

Please sign in to comment.