summaryrefslogtreecommitdiffstats
path: root/desktop/ansiweather/README
diff options
context:
space:
mode:
Diffstat (limited to 'desktop/ansiweather/README')
-rw-r--r--desktop/ansiweather/README14
1 files changed, 14 insertions, 0 deletions
diff --git a/desktop/ansiweather/README b/desktop/ansiweather/README
new file mode 100644
index 0000000000..ef5a9fea54
--- /dev/null
+++ b/desktop/ansiweather/README
@@ -0,0 +1,14 @@
+AnsiWeather is a Shell script for displaying the current weather
+Comditions in your terminal.It supports support for ANSI colors
+and Unicode symbols.Weather data comes from OpenWeatherMap,
+free weather API.
+
+A list of cities is available,you can view it by running
+less /usr/doc/ansiweather-1.19.0/city.list.json
+
+A sample configuration file ansiweatherrc is provided in
+the documentation folder you can copy it to
+$HOME/.ansiweatherrc
+
+By default AnsiWeather uses its own key, but users can optionally
+get their own one by creating a free OpenWeatherMap account.