From 32d18571675595282ada3a9ec3203db2385a12d2 Mon Sep 17 00:00:00 2001 From: cijo7 Date: Mon, 10 Dec 2018 00:08:39 +0530 Subject: [PATCH] added README. --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..26499f1 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# Halo - The Weather App +Halo is a weather app written in python. It will automatically display weather +at the user location based on the user ip, or can be used to view weather data from specific locations. + +

+ +

+ +## Prerequisites + +1. Python 3 +1. Pip + +## Installation + +You can [download](https://github.com/cijo7/Halo/raw/master/dist/Halo-0.1.0.tar.gz) the package and install it by running + + sudo python3 setup.py install + +## Usage +After installing you directly launch the app either by searching for Halo, or from terminal by running + + halo + +### Running directly from Source + +You need to first install the dependencies manually by running + + pip3 install -r requirements.txt + +Then run the module + + python3 -m halo + + +