Skip to content

Commit

Permalink
Readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
baranonen committed Jun 16, 2020
1 parent d90a9dd commit a708d68
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# oleddit
# Oleddit
A very tiny Reddit client that runs on a 0.96 inch OLED screen with a Raspberry Pi </br>
Work in progress
## Usage
Download these fonts and copy the .ttf files to the same directory as the python file: </br>
[VCD OSD Mono](https://www.dafont.com/vcr-osd-mono.font "VCD OSD Mono")</br>
[Coder's Crux](https://www.dafont.com/coders-crux.font "Coder's Crux") </br>
After copying them, run oleddit.py</br>
Make sure that you have all of the necessary libraries installed </br>
Install the [Adafruit SSD 1306 library](https://github.com/adafruit/Adafruit_Python_SSD1306 "Adafruit SSD 1306 library")</br>
Prepare the circuit according to this schematic</br>
![Oleddit Schematic](https://raw.githubusercontent.com/baranonen/oleddit/master/Schematics/Oleddit.png "Oleddit Schematic")</br>
Run oleddit.py</br>
You can change the `subreddit` variable to load posts from another subreddit</br>

0 comments on commit a708d68

Please sign in to comment.