From 74300cdf7114667eab9278a83e191508ea160571 Mon Sep 17 00:00:00 2001 From: ghost Date: Sun, 23 Apr 2023 09:03:02 +0300 Subject: [PATCH] update readme --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5de590a..7db600b 100644 --- a/README.md +++ b/README.md @@ -32,11 +32,12 @@ sphinxsearch #### Installation -* The webroot dir is `/public` -* Single configuration file placed here `/config/app.php.txt` and need to be configured and renamed to `/config/app.php` -* By the idea, script automaticaly generates database structure in `/storage` folder (where could be nice to collect other variative and tmp data - like logs, etc). Make sure storage folder writable. -* Set up the `/crontab/crawler.php` script for execution every the minute, but it mostly related of the configs and targetal network volume, there is no debug implemented yet, so let's silentize it by `/dev/null` -* Script has no MVC model, because of super simple. It's is just 2 files, and everything else stored incapsulated in `/library` classes. +* The web root dir is `/public` +* Deploy the database using MySQL Workbench project presented in the `/database` folder +* Install [Sphinx Search Server](https://sphinxsearch.com) +* Configuration examples are placed at `/config` folder +* Make sure `/storage` folder is writable +* Set up the `/crontab` scripts by following [examples](https://github.com/YGGverse/YGGo#crontab) #### Configuration