README should be more helpful

nnev / kzeen-wo-ist-die-pizza

pizza <3 | UNMAINTAINED / ABANDONED, pls see pizza4c

ISC License

5 stars 1 forks source link

README should be more helpful #1

Closed sur5r closed 6 years ago

sur5r commented 7 years ago

The current README makes it very hard to set this up. Would be nice if it could be improved.

breunigs commented 7 years ago

this sounds like a good first bug. Would you like to contribute @sur5r ?

breunigs commented 7 years ago

@sur5r, I have updated the README and added example configuration files. Can you take a look if this is sufficient to get it up and running? If not, please write down where you got stuck and I will add it to a more thorough guide.

sur5r commented 7 years ago

Looks pretty straightforward. I will test it in the next couple of days and report back.

sur5r commented 6 years ago

After setting it up on eris I think the setup instructions in the README are fine.