From 3fe2e12da227f5605bfa637d0a13b7634c36a36e Mon Sep 17 00:00:00 2001 From: Junior Date: Sun, 10 Nov 2024 16:20:03 -0500 Subject: [PATCH] Add a readme file --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..11e9c50 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# Book Depot + +A quick and dirty web interface to provide access for downloading e-books and sending them directly to a Kindle email address. + +## Installation + +* Clone repository and enter that folder +* Execute: `composer install` +* Copy `variables-dist.php` to `variables.php` and edit appropriately +* Create database on SQL server, create a DB user for this application, and import the `books_initial.sql` +* Create a cron job that runs `install/parsebooks.php` daily