From 33b8c4d8e42778103dc6add35104e9685594d19b Mon Sep 17 00:00:00 2001 From: nyx Date: Fri, 31 Jan 2025 01:09:51 -0600 Subject: [PATCH] new readme :D --- README.md => README.original.md | 0 src/imag/README.md | 41 +++++++++++++++++++++++++++++++++ 2 files changed, 41 insertions(+) rename README.md => README.original.md (100%) create mode 100644 src/imag/README.md diff --git a/README.md b/README.original.md similarity index 100% rename from README.md rename to README.original.md diff --git a/src/imag/README.md b/src/imag/README.md new file mode 100644 index 0000000..a039ed1 --- /dev/null +++ b/src/imag/README.md @@ -0,0 +1,41 @@ +# imag: weird image board thingy + +> note: this is a fork of a project that doesn't exist anymore. this document is mostly paraphrased from README.original.md. + +this is intended to be hacked upon! please do make forks and tell the creator what you've made. our "showcase" is at [quotes.everypizza.im](https://quotes.everypizza.im/). +it has an import from quotes.ari.lt, however said import was missing some images. if anyone has those, please reach out! + +# prerequisites + +- tesseract +- tesseract data +- python + +# bot + +it seems nobody has the source code for the Matrix bot as far as this one can tell. it might ask Ari later though. + +# running + +first run: +```sh +python3 src/main.py +``` +this generates a key. keep it, you need it to add new images! + +afterwards: +```sh +rm -rf src/images src/instance +``` +### step-by-step + +> these are directly from the original docs. + +this comes from an email i got from a user : + +1. clone the repository : `git clone https://ari.lt/gh/imag && cd imag` +2. make sure you have virtualenv installed ( either through python-virtualenv / python3-virtualenv / py3-virtualenv packages, or by pip - `python3 -m pip install --user --break-system-packages --upgrade virtualenv` +3. ensure you have sqlite3 and memcached installed : `apt install sqlite3 memcached` +4. create a new virtual environment : `python3 -m virtualenv venv && source venv/bin/activate` +5. install the dependencies in the environment : `pip install -r requirements.txt` +6. run the app by either running `scripts/run.sh` or by manually starting memcached and running `src/main.py` with gunicorn ( i assume you're reverse proxying it anyway )