fix, remove readme that wasn't supposed to be there

This commit is contained in:
nyx 2025-02-01 16:30:45 -06:00
parent d65bcb3e4a
commit d50b0bd8de
2 changed files with 1 additions and 41 deletions

View file

@ -62,5 +62,5 @@ this comes from an email the original creator got from a user:
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. configure the instance: `cp src/imag/config.sample.json src/imag/config.json && nano config.json`
6. configure the instance: `cp src/imag/config.sample.json src/imag/config.json && nano src/imag/config.json`
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)

View file

@ -1,40 +0,0 @@
# 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/).
# prerequisites
- tesseract
- tesseract data
- python
# bot
there's a very small bot at [n/quotes-bot](https://git.everypizza.im/n/quotes-bot). copied from the original with some very small changes.
# 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://git.everypizza.im/n/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 )