From ca94e0cfc558f8667a1196f5e4c4c5ee6034684b Mon Sep 17 00:00:00 2001
From: Aqua-sama <aqua@iserlohn-fortress.net>
Date: Sun, 30 Jul 2017 14:12:24 +0200
Subject: Updated documentation

---
 docs/Design Notes.md | 35 -----------------------------------
 docs/manual.md       | 31 +++++++++++++++++++++++++++++++
 2 files changed, 31 insertions(+), 35 deletions(-)
 delete mode 100644 docs/Design Notes.md
 create mode 100644 docs/manual.md

(limited to 'docs')

diff --git a/docs/Design Notes.md b/docs/Design Notes.md
deleted file mode 100644
index 62bb44f..0000000
--- a/docs/Design Notes.md	
+++ /dev/null
@@ -1,35 +0,0 @@
-## Features
-The aim of this project is to provide a small and fast web browser.
-
-### General
-* Use generic formats
-
-### Version 1.0
-* Profiles
-  - Application-level profile manager
-  - System-level and user-level profile config, with per-profile overrides [todo]
-* Configuration
-  - Default system-level config and user-level overrides [todo]
-* Cookies
-  - Filter list similar to the URL filter list [todo]
-* Tabs
-  - Moving tabs between windows [todo]
-  - Tab context menu [todo]
-* Page actions
-  - Search [todo]
-  - Zoom [todo]
-  - Print [todo]
-* Navigation toolbar
-  - Back and Forward history [todo]
-
-## Dependencies
-* Qt, over 5.7 (up-to-date Qt version recommended)
-* qbs, over 1.6.0 (Qt 5.7)
-
-## Notes
-An optional system proxy should be picked up automatically. However, for proxies that require a username or password, you need to connect to QWebEnginePage::proxyAuthenticationRequired.
-
-Qt WebEngine Widgets uses the Qt Quick Scene Graph to compose the page. Therefore, OpenGL support is required.
-And that's also why QML is a dependancy.
-
-To use clang with QtCreator, you need to change the compiler in Build & Run » Kits, not the qbs profile.
diff --git a/docs/manual.md b/docs/manual.md
new file mode 100644
index 0000000..971ba94
--- /dev/null
+++ b/docs/manual.md
@@ -0,0 +1,31 @@
+### Command-line parameters
+ Parameter       | Description                     | Usage
+-----------------|---------------------------------|-------
+-h               | Display help information        |
+-v, --version    | Display version information     |
+-c, --config     | Set a custom configuration file | 
+--default-config | Print default configuration     | Useful for writing user overrides.
+-p, --profile    | Select a profile                |
+-n, --no-plugins | Don't load plugins on startup   |
+--new-instance   | Skip instance check on startup  |
+--in-new-window  | Open URL in a new window        |
+--in-new-tab     | Open URL in a new tab           |
+
+
+### Version 1.0
+* Profiles
+  - Application-level profile manager
+  - System-level and user-level profile config, with per-profile overrides [todo]
+* Configuration
+  - Default system-level config and user-level overrides [todo]
+* Cookies
+  - Filter list similar to the URL filter list [todo]
+* Tabs
+  - Moving tabs between windows [todo]
+  - Tab context menu [todo]
+* Page actions
+  - Search [todo]
+  - Zoom [todo]
+  - Print [todo]
+* Navigation toolbar
+  - Back and Forward history [todo]
-- 
cgit v1.2.1