Split readme into dedicated documentation files

Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>

3 files changed, 107 insertions, 0 deletions

diff --git a/doc/admin.md b/doc/admin.md
new file mode 100644
index 000000000..fbbc86128
--- /dev/null
+++ b/doc/admin.md
@@ -0,0 +1,56 @@
+# Nextcloud Mail Admin Documentation
+
+[TOC]
+
+## Installation
+
+In your Nextcloud, simply navigate to »Apps«, choose the category »Social & Communication«, find the Mail app and enable it.
+Then open the Mail app from the app menu. Put in your mail account credentials and off you go!
+
+## Configuration
+
+Certain advanced or experimental features need to be specifically enabled in your `config.php`:
+
+### Timeouts
+Depending on your mail host, it may be necessary to increase your IMAP and/or SMTP timeout threshold. Currently IMAP defaults to 20 seconds and SMTP defaults to 2 seconds. They can be changed as follows:
+
+#### IMAP timeout
+```php
+'app.mail.imap.timeout' => 20
+```
+#### SMTP timeout
+```php
+'app.mail.smtp.timeout' => 2
+```
+### Use php-mail for sending mail
+You can use the php-mail function to send mails. This is needed for some webhosters (1&1 (1und1)):
+```php
+'app.mail.transport' => 'php-mail'
+```
+
+## Troubleshooting
+
+### Gmail
+
+If you can not access your Gmail account use https://accounts.google.com/DisplayUnlockCaptcha to unlock your account.
+
+### Outlook.com
+
+If you can not access your Outlook.com account try to enable the 'Two-Factor Verification' (https://account.live.com/proofs/Manage) and set up an app password (https://account.live.com/proofs/AppPassword), which you then use for the Nextcloud Mail app.
+
+### Dovecot IMAP
+
+If your Dovecot IMAP server prefixes all folders with `INBOX`, Nextcloud Mail does not work correctly.
+
+Check `/etc/dovecot/dovecot.conf`:
+
+```
+namespace inbox {
+        separator = .
+        # All folders prefixed
+        # prefix = INBOX.
+        prefix =
+        inbox = yes
+        type = private
+}
+```
diff --git a/doc/developer.md b/doc/developer.md
new file mode 100644
index 000000000..ec2b69428
--- /dev/null
+++ b/doc/developer.md
@@ -0,0 +1,33 @@
+# Nextcloud Mail Developer Documentation
+
+[TOC]
+
+## Developer setup info
+
+Just clone this repo into your apps directory (Nextcloud server installation needed). Additionally, [npm](https://www.npmjs.com/) to fetch [Node.js](https://nodejs.org/en/download/package-manager/) is needed for installing JavaScript dependencies.
+
+Once npm and Node.js are installed, PHP and JavaScript dependencies can be installed by running:
+```bash
+make install-composer-deps
+make optimize-js
+```
+
+## Nightly builds
+
+Instead of setting everything up manually, you can just [download the nightly builds](https://nightly.portknox.net/mail/?C=M;O=D) instead. These builds are updated every 24 hours, and are pre-configured with all the needed dependencies.
+
+1. Download
+2. Extract the tar archive to 'path-to-nextcloud/apps'
+3. Navigate to »Apps«, choose the category »Productivity«, find the Mail app and enable it.
+
+The nightly builds are provided by [Portknox.net](https://portknox.net)
+
+## Resetting the app
+Connect to your database and run the following commands (`oc_` is the default table prefix):
+```sql
+DELETE FROM oc_appconfig WHERE appid = 'mail';
+DROP TABLE oc_mail_accounts;
+DROP TABLE oc_mail_aliases;
+DROP TABLE oc_mail_collected_addresses;
+DROP TABLE oc_mail_attachments;
+```
\ No newline at end of file
diff --git a/doc/user.md b/doc/user.md
new file mode 100644
index 000000000..35752c027
--- /dev/null
+++ b/doc/user.md
@@ -0,0 +1,18 @@
+# Nextcloud Mail User Documentation
+
+[TOC]
+
+## Keyboard shortcuts
+
+Speed up your Mail experience by using keyboard shortcuts.
+
+| Action        | Shortcut                           |
+| ------------- | ---------------------------------- |
+| Newer message | <kbd>K</kbd> or <kbd>←</kbd>       |
+| Older message | <kbd>J</kbd> or <kbd>→</kbd>       |
+| Toggle star   | <kbd>S</kbd>                       |
+| Toggle unread | <kbd>U</kbd>                       |
+| Delete        | <kbd>Del</kbd>                     |
+| Search        | <kbd>Ctrl</kbd> + <kbd>F</kbd>     |
+| Send          | <kbd>Ctrl</kbd> + <kbd>↵</kbd> |
+| Refresh       | <kbd>R</kbd>                       |