diff --git a/README.md b/README.md index bcd5fad..2d8aecc 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,18 @@ # toastbin Bad Pastebin clone made to look like Forgejo (well, eventually at least). + +# docs + +todo: make this more complete + +currently, there's no reason to run this except for development. however, if you want to comtribute, you can submit pull requests either of these ways: +- ask for a git.everypizza.im account (contact the admin with either @n:everypizza.im (matrix) or nyx@everypizza.im (xmpp)) +- send patches in a dm with either of those listed accounts. + +### running + +1. clone the repository +2. copy `src/toastbin/config.sample.json` to `src/toastbin/config.json` +3. install dependencies (currently, we just need `flask` but this almost absoultely will change) +4. run `src/toastbin/app.py` (`python3 src/toastbin/app.py`)