update README to include adafruit license
[hardpass.git] / README.md
4a792a27 1# Hardpass Prototype, v.2
2A Raspberry Pi Zero based WiFi Enabled Hardware Password Manager, now with a PCB.
bc85b807 3
4## Currently Implemented:
5 - OLED (demo)
6 - USB Gadgets (full)
7 - USB HID send keys progam
9## TODO
10- OLED: Menu program
11- WiFi: compile & install driver
12- Button Matrix (same program as OLED)
14## Install ESP driver
15If you want to use the ESP8266 on the SDIO pins of the Pi, download and install the driver from Andrew Litt.
17# on the pi:
18git clone https://github.com/al177/esp8089.git
19make && sudo make install
22## In this repository
23This repository contains:
24 * USB HID progam `scan` with examples in `./send_hid`
25 * OLED menu system in `./oled`, using the `ArduiPi_OLED` driver from http://hallard.me
26 * Patcher and installer for `pass` in `./pass`
27 * KiCAD schematic and PCB layout in `./kicad`
30## Setting up
31To automatically load necessary kernel modules for the OLED on boot, run as root on the Pi:
33echo "i2c-dev">>/etc/modules
34echo "dwc2">>/etc/modules
37A small systemd unit file is included; place it in `/etc/systemd/system/` and modify it, so it points to `init_usb.sh`, which you can also modify to your needs.
39## License
40I hereby release my work under the GNU GPLv3 where applicable. The complete license text, if not included, can be read at `https://www.gnu.org/licenses/gpl-3.0.txt`. Where the GPLv3 isn't applicable, the work is released under the Creative Commons Attribution-ShareAlike 4.0 International.
41This repository also includes the ArduiPi_OLED library from [hallard](https://github.com/hallard); see [this website](http://hallard.me/adafruit-oled-display-driver-for-pi/) for details.
4a792a27 42and the kicad-ESP8266 library from [jdunmire](https://github.com/jdunmire/kicad-ESP8266), which is released under the Creative Commons Attribution-ShareAlike 4.0 International License.
Imprint / Impressum