Create README.md

2 years ago · 1dcd2092e7
parent 0f6716ac09
commit 1dcd2092e7
1 changed files with 11 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,11 @@
+# TDF Badger 🖨️ 📛 🦡
+TDF Badge printer with webinterface
+
+## Requirements
+* A webserver, e.g. `apache2`
+* `php` with `php-gd`
+* `ImageMagick` for `convert`
+* A folder named `uploads` inside your webservers root directory
+* full read/write permissions for the webserver user on the `uploads` folder
+* the [ql570](https://github.com/sudomesh/ql570) binary inside the webservers root dir
+* the `ComicCodeMedium.otf` font file inside the webservers root dir