From 3960e17c2222366fb47366f5b5d46d768e2842c0 Mon Sep 17 00:00:00 2001 From: Nick White Date: Sat, 14 Nov 2020 15:20:48 +0000 Subject: Add module support, license, readme --- README | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 README (limited to 'README') diff --git a/README b/README new file mode 100644 index 0000000..19cc490 --- /dev/null +++ b/README @@ -0,0 +1,31 @@ +# njw.name/weather package + +This package is a command that prints the weather forecast for a +location, using either the Met Office or BBC as a source. + +This is a Go package, and can be installed in the standard go way, +by running `git clone https://git.njw.name/bbcschedule` and +`go install .` from the bbcschedule directory. + +Note that the location must be set manually from the Go code, see +`metdefid` and `bbcdefid`. Relatedly, note that this was the first +Go program I wrote. Look elsewhere for examples of best practise. + +## Usage + + Usage: weather [-b] [-n int] [-v] + + -b use bbc as data source (default true) + -n int + number of days to show (default 2) + -v verbose: show all weather details + +## Contributions + +Any and all comments, bug reports, patches or pull requests would +be very welcomely received. Please email them to . + +## License + +This package is licensed under the GPLv3. See the LICENSE file for +more details. -- cgit v1.2.3