Skip to content

Commit

Permalink
added README.
Browse files Browse the repository at this point in the history
  • Loading branch information
cijo7 committed Dec 9, 2018
1 parent f689088 commit 32d1857
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

<p align="center">
<img src="https://github.com/cijo7/Halo/raw/master/preview.gif">
</p>

## 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



0 comments on commit 32d1857

Please sign in to comment.