From 1162d086cab8bc14fd70107752b4a539630d9175 Mon Sep 17 00:00:00 2001 From: "Daniel D. Beck" Date: Sun, 19 Mar 2017 14:29:35 +0000 Subject: [PATCH] Update README.md following my own README suggestions https://github.com/ddbeck/readme-checklist/blob/master/checklist.md --- README.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 48e50ae..972c04d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ Star Near You ============= +by [@ddbeck](https://twitter.com/ddbeck) + [Star Near You](https://twitter.com/starnearyou) is a bot that's tweeting animated GIFs of the Sun's corona using data from a NASA spacecraft, the [Solar Dynamics Observatory](http://sdo.gsfc.nasa.gov/). It's scheduled to tweet three times a day, showing a time-lapse view of the Sun during the previous eight hours. A typical GIF looks like this: ![](sample.gif) @@ -17,10 +19,17 @@ Thanks to NASA/SDO and the AIA, EVE, and HMI science teams for providing the dat Installation and configuration ------------------------------ +To set up Star Near You, you'll need the following: + +* Python 3.5 or later +* ImageMagick +* Gifsicle + To install and configure Star Near You: 1. Run `pip install https://github.com/ddbeck/starnearyou`. - 2. Create a [Twitter API app](https://apps.twitter.com/) and put your API keys in a JSON file, like this: + 2. Create a work directory with two subdirectories, `gifs` and `originals`. This is where downloaded files and generated GIFs are stored. + 3. Create a [Twitter API app](https://apps.twitter.com/) and put your API keys in a JSON file, like this: ``` { @@ -31,14 +40,16 @@ To install and configure Star Near You: } ``` - 3. Run `starnearyou --keyfile --request-access`, where `` is the path to the JSON file you created in the previous step. - 4. Follow the instructions shown. When you're finished, add the access key and secret to the JSON file. + 4. Run `starnearyou --keyfile --request-access`, where `` is the path to the JSON file you created in the previous step. + 5. Follow the instructions shown. When you're finished, add the access key and secret to the JSON file. Usage ----- -To tweet with Star Near You, run `starnearyou --keyfile `. +To tweet with Star Near You, run `starnearyou --keyfile ` in your work directory. + +Although this is an art piece, if you need help or have a suggestion for improving this bot, then you may open an issue on the GitHub repository. License