[damned-lies/develop] docs: refer to the wiki instead of having instructions in the README



commit 62e29a7783eaec8e7db90a41d56dafecf81d5f31
Author: Guillaume Bernard <associations guillaume-bernard fr>
Date:   Tue Sep 6 10:34:51 2022 +0200

    docs: refer to the wiki instead of having instructions in the README

 README.md | 55 ++-----------------------------------------------------
 1 file changed, 2 insertions(+), 53 deletions(-)
---
diff --git a/README.md b/README.md
index 7e0b28bb..7813fb58 100644
--- a/README.md
+++ b/README.md
@@ -13,57 +13,6 @@ You can find the Data model in the `/docs` directory.
 Please, refer to the [Contribution guide](CONTRIBUTING.md) in order to know how to install `damned-lies` in a
 development environment.
 
-<!-- This should be moved to a documentation instead of remaining in the README file -->
+## Documentation
 
-## Maintenance tasks
-
-There is a management command to run maintenance tasks (clean never-activated accounts, inactivate unused 
roles, …):
-
-```bash
-./manage.py run-maintenance
-```
-
-Note: it might be useful to add the command in a cron schedule.
-
-<!-- This should be moved to a documentation instead of remaining in the README file -->
-
-## Databases
-
-It’s important to use the Unix Domain Socket connection to obtain good performances.
-
-### PostgreSQL
-
-In the `DATABASES['default']` dictionary, you just need to define `ENGINE = 'django.db.backends.postgresql'`
-and the `NAME` key. Leave the `HOST` setting empty to use `UDS`.
-
-### MySQL
-
-Create a database in UTF8, either with `default-character-set = utf8` under `[mysqld]` section in the 
`my.cnf` file or
-with an explicit SQL instruction:
-
-```sql
-CREATE
-DATABASE <DATABASE_NAME> charset=utf8;
-```
-
-Then, you have to update your `damnedlies/local_settings.py`:
-
-```python
-DATABASES = {
-    'default': {
-        'ENGINE': 'django.db.backends.mysql',
-        'NAME': '<your database name>',
-        'USER': '<your user>',
-        'PASSWORD': '<your password>',
-        'HOST': '/var/run/mysqld/mysqld.sock',
-        'OPTIONS': {
-            'read_default_file': '/etc/mysql/my.cnf',
-        }
-    }
-}
-```
-
-Grep for `ANSI_QUOTES` in the source code to find the `models.py` which use a hack to workaround the double 
quotes
-interpretation in MySQL. The best solution is to run the MySQL server with
-the [`ANSI_QUOTES` mode](http://dev.mysql.com/doc/refman/5.7/en/sql-mode.html) (`sql-mode="ANSI_QUOTES"` in 
`my.cnf`),
-but it can be damaging for other applications.
+To know how `damned-lies` works and how you should install and use it for production, please refer to the 
[`damned-lies` wiki](../../wiki). If you wish to install it in order to contribute, again, please read the 
[Contribution guide](CONTRIBUTING.md).


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]