diff --git a/README.md b/README.md index dee32bf..fc800bd 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ -# oleddit +# Oleddit A very tiny Reddit client that runs on a 0.96 inch OLED screen with a Raspberry Pi
-Work in progress ## Usage Download these fonts and copy the .ttf files to the same directory as the python file:
[VCD OSD Mono](https://www.dafont.com/vcr-osd-mono.font "VCD OSD Mono")
[Coder's Crux](https://www.dafont.com/coders-crux.font "Coder's Crux")
-After copying them, run oleddit.py
-Make sure that you have all of the necessary libraries installed
+Install the [Adafruit SSD 1306 library](https://github.com/adafruit/Adafruit_Python_SSD1306 "Adafruit SSD 1306 library")
+Prepare the circuit according to this schematic
+![Oleddit Schematic](https://raw.githubusercontent.com/baranonen/oleddit/master/Schematics/Oleddit.png "Oleddit Schematic")
+Run oleddit.py
You can change the `subreddit` variable to load posts from another subreddit
\ No newline at end of file