diff --git a/README.md b/README.md index c22380d..455c6cb 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,29 @@ -This will be full suite of scripts and systemd service to download NSFW content from multiple different websites +# HDB -This will also contain a lot of other random useful files and folders +## Build + +### Build dependencies + +- GNU/Linux (can be determined using 'uname -o') +- \_POSIX\_C\_Source >= 200112L +- Gcc +- libsqlite3 + +### Runtime dependencies + +- glibc +- libsqlite3 + +### Building + +Firstly make sure you have [cloned](https://git-scm.com/docs/git-clone) the repository to your system. + +This project ships with a Makefile which can be used for compiling a debug version or a release version. + +The debug version is made using '-ggdb', so if you use a debugger other than [GDB](https://sourceware.org/gdb), you will need to modify the Makefile + +By default it compiles the debug version. To compile the build version, you can run the following command in a terminal. -# Certified hood classic ```bash -docker exec hentai_postgres bash -c "pg_dumpall -U hentai > /var/lib/postgresql/dump$(date +'%F').sql" -``` - -Change the input file accordingly -```bash -docker exec -i hentai_postgres bash -c "PGPASSWORD=h99nqaNPhpfbuuhCDwQXLpZAnoVTjSQP7taoqmQhpzc2rPLVC4JUAKxAHfuuhuU9 psql --username hentai" < ~/docker/Hentai/db/dump.sql +make release ```