Update README.md

[uguu.git] / README.md

diff --git a/README.md b/README.md
index b22b50296967b54181ede749522f650dd62f88ce..3697f4e01dd5f50cfb91030e58a5b3e8b5e56ec7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -20,8 +20,8 @@ See the real world example at [uguu.se](https://uguu.se).
 
 ## Requirements
 
-Original development environment is Nginx + PHP7.3 + SQLite, but is confirmed to
-work with Apache 2.4 and newer PHP versions.
+Original development environment is Nginx + PHP5.3 + SQLite, but is confirmed to
+work with Apache 2.4 and newer PHP versions like PHP7.3.
 
 ## Install
 
@@ -31,19 +31,13 @@ Node, or NPM. So we'll just assume you already have them all running well.
 ### Compiling
 
 First you must get a copy of the uguu code.  To do so, clone this git repo.
-You will need to recursively clone the repo to get the required PHP submodule,
-and the optional user panel submodule.
-```bash
-git clone --recursive https://github.com/nokonoko/uguu
-```
-If you don't want either of the submodules run the following command,
 ```bash
 git clone https://github.com/nokonoko/uguu
 ```
 
-Assuming you already have Node and NPM working, compilation is easy. If you would like any additional submodules, or to exclude the default PHP submodule, use the `MODULES="..."` variable.
+Assuming you already have Node and NPM working, compilation is easy.
 
-Run the following commands to do so.
+Run the following commands to do so, please configure `dist.json` before you compile.
 ```bash
 cd uguu/
 make
@@ -62,7 +56,12 @@ file size, are found in `dist.json`.  Changes made here will
 only take effect after rebuilding the site pages.  This may be done by running
 `make` from the root of the site directory.
 
-Back-end related settings, such as database configuration, and path for uploaded files, are found in `static/php/includes/settings.inc.php`.  Changes made here take effect immediately.
+Back-end related settings, such as database configuration, and path for uploaded files, are found in `static/php/includes/settings.inc.php`.  Changes made here take effect immediately. Change the following settings:
+```php
+define('UGUU_DB_CONN', 'sqlite:/path/to/db/uguu.sq3');
+define('UGUU_FILES_ROOT', '/path/to/file/');
+define('UGUU_URL', 'https://subdomainforyourfiles.your.site');
+```
 
 If you intend to allow uploading files larger than 2 MB, you may also need to
 increase POST size limits in `php.ini` and webserver configuration. For PHP,
@@ -93,7 +92,7 @@ First create a directory for the database, e.g. `mkdir /var/db/uguu`.
 Then, create a new SQLite database from the schema, e.g. `sqlite3 /var/db/uguu/uguu.sq3 -init /home/uguu/sqlite_schema.sql`.
 Then, finally, ensure the permissions are correct, e.g.
 ```bash
-chown nginx:nginx /var/db/uguu
+chown www-data:www-data /var/db/uguu
 chmod 0750 /var/db/uguu
 chmod 0640 /var/db/uguu/uguu.sq3
 ```