commit 4a650682e022152fb1d4624e8e534779c6919df8 parent b9f5516a3b83f4e5c7d6facc861a889a4384d15d Author: Frederic Cambus <fcambus@users.sourceforge.net> Date: Sat, 19 Oct 2013 13:52:06 +0200 Adding documentation Diffstat:
| A | README.md | | | 58 | ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 58 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -0,0 +1,58 @@ +## Description + +AnsiWeather is a Shell script for displaying the current weather conditions in your +terminal, with support for ANSI colors and Unicode symbols. + +Weather data comes from the `OpenWeatherMap` free weather API. + +## Requirements + +AnsiWeather requires the following dependencies : + +- cURL (used to fetch Weather data) : http://curl.haxx.se +- jq (lightweight and flexible command-line JSON processor) : http://stedolan.github.io/jq/ + +## Usage + +After cloning the repository, simply invoke the script by typing : + + ./ansiweather + +## Configuration + +The following configuration options are available and should be set according +to your location and preferences. + +### Location + +Example : `Moscow,RU` + + location="Moscow,RU" + +### System of Units + +Both `metric` and `imperial` systems are supported. + + units="metric" + +### Display symbols + +Toggle Unicode symbols display `true` or `false` (requires an Unicode capable display). + + symbols=true + +## License + +AnsiWeather is released under the BSD 3-Clause license. See `LICENSE` file +for details. + +## Author + +AnsiWeather is developed by Frederic Cambus + +- Site : http://www.cambus.net +- Twitter: http://twitter.com/fcambus + +## Resources + +GitHub : https://github.com/fcambus/ansiweather