Changed code to python3, add README.md
This commit is contained in:
48
README.md
Normal file
48
README.md
Normal file
@@ -0,0 +1,48 @@
|
||||
# Clocky
|
||||
|
||||
A minimal, Raspberry Pi based, music playing alarmclock.
|
||||
|
||||
## Getting Started
|
||||
|
||||
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Clocky is build with python 3 and is using the following libraries:
|
||||
|
||||
[RPi.GPIO](http://sourceforge.net/projects/raspberry-gpio-python/) - handling hardware I/O for the buttons and 7-segment display
|
||||
[Luma.LED_Matrix](https://github.com/rm-hull/luma.led_matrix) - for driving the matrix display
|
||||
[Pygame](https://www.pygame.org/) - for playing audio
|
||||
|
||||
|
||||
Needed to install before running Clocky:
|
||||
|
||||
```
|
||||
sudo apt-get update
|
||||
sudo apt-get upgrade
|
||||
sudo apt-get install python3-pip3
|
||||
sudo apt-get install build-essential python-dev python-pip libfreetype6-dev libjpeg-dev libopenjp2-7 libtiff5
|
||||
|
||||
pip3 install RPI.GPIO
|
||||
pip3 install luma.led_matrix
|
||||
pip3 install pygame
|
||||
```
|
||||
|
||||
### Installing
|
||||
|
||||
A step by step series of examples that tell you how to get a development env running
|
||||
|
||||
Say what the step will be
|
||||
|
||||
```
|
||||
Give the example
|
||||
```
|
||||
|
||||
### Hardware
|
||||
|
||||
Overview of used hardware:
|
||||
|
||||
[Raspberry Pi Zero-W](https://www.raspberrypi.org/products/raspberry-pi-zero-w/)
|
||||
max7219 4*8*8 LED Matrix module
|
||||
tm1637 4*7-Segment dispplay
|
||||
|
||||
Reference in New Issue
Block a user