Skip to content

Commit

Permalink
Merge pull request #15 from chrishutchinson/fix/readmeRequirements
Browse files Browse the repository at this point in the history
fix: Add requirements to README, and update some copy
  • Loading branch information
chrishutchinson committed Jun 9, 2019
2 parents 24af66a + bb44fe2 commit e791de6
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,40 @@

![Example output of the script](capture.png)

## Requirements

To run this code, you will need Python 3.6+.

### Raspbian

If you're using Raspbian Lite, you'll also need to install:

- `libopenjp2-7`

with:

```bash
$ sudo apt-get install libopenjp2-7
```

## Usage

1. Clone this repo

2. Install dependcies
2. Install dependencies

```bash
$ pip install -r requirements.txt
```

3. Sign up for the [Transport API](https://www.transportapi.com/), and generate an app ID and API key

4. Copy `config.sample.json` to `config.json` and complete the values, including your Transport API keys from step 3. Note: station names should be provided as their three-letter station code, all available [here](https://www.nationalrail.co.uk/stations_destinations/48541.aspx).
4. Copy `config.sample.json` to `config.json` and complete the values, including your Transport API keys from step 3. _Note: station names should be provided as their three-letter station code, all available [here](https://www.nationalrail.co.uk/stations_destinations/48541.aspx)._

5. Start the app with:

```bash
$ python ./src/main.py --display pygame --width 256 --height 64

```

Change the `--display` flag to alter the output mechanism (a list of options can be found in this README: https://github.com/rm-hull/luma.examples). Use `capture` to save to images, and `pygame` to run a visual emulator.
Expand All @@ -35,6 +50,10 @@ Remember to pass `--interface spi` if you are using SPI to communicate with your
$ python ./src/main.py --display ssd1322 --width 256 --height 64 --interface spi
```

## Video demo

I've tweeted a video demo of the software running on a real device: https://twitter.com/chrishutchinson/status/1136743837244768257

## Thanks

The fonts used were painstakingly put together by `DanielHartUK` and can be found on GitHub at https://github.com/DanielHartUK/Dot-Matrix-Typeface - A huge thanks for making that resource available!

0 comments on commit e791de6

Please sign in to comment.