diff options
| author | Aqua-sama <aqua@iserlohn-fortress.net> | 2017-10-12 14:21:02 +0200 |
|---|---|---|
| committer | Aqua-sama <aqua@iserlohn-fortress.net> | 2017-10-12 14:21:02 +0200 |
| commit | 50a654638c0f371a965e2ea26683d834c7f7508f (patch) | |
| tree | 65f6c0620aeb27e89d409218b1fa6a20a7df1796 /docs | |
| parent | Fixed crash on exit properly (diff) | |
| download | smolbote-50a654638c0f371a965e2ea26683d834c7f7508f.tar.xz | |
Updated documentation
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/manual/Building.Dependencies.md | 2 | ||||
| -rw-r--r-- | docs/manual/Features.1.0.md | 54 | ||||
| -rw-r--r-- | docs/manual/Features.md | 2 |
3 files changed, 5 insertions, 53 deletions
diff --git a/docs/manual/Building.Dependencies.md b/docs/manual/Building.Dependencies.md index a506958..2f9bcdd 100644 --- a/docs/manual/Building.Dependencies.md +++ b/docs/manual/Building.Dependencies.md @@ -5,7 +5,7 @@ - at least 5.9 - core, widgets - webengine, webenginewidgets -- [libconfig](http://hyperrealm.com/libconfig/libconfig.html) +- [libtoml](https://github.com/mayah/tinytoml) (included in source) ### Tools * A working compiler diff --git a/docs/manual/Features.1.0.md b/docs/manual/Features.1.0.md index 31ad978..59348d3 100644 --- a/docs/manual/Features.1.0.md +++ b/docs/manual/Features.1.0.md @@ -16,50 +16,6 @@ * Navigation toolbar - Back and Forward history [todo] -## Overall design of smolbote - -The aim of smolbote is to be a lightweight and fast, to the point web browser. - -### How smolbote works [TODO] - -0. Launch -1. Check for other instance, unless otherwise specified - - If other instance is found, pass the parameters to it and quit - - Else, create a new instance -2. Create application object - - Read configuration - _ Create profiles -3. Pass parameters to application object - - Create main window if there isn't one - - open URLs - -### main() and smolmain() [TODO] - -The main() function should contain all code to start up, check for another -running instance, and if necessary pass the parameters to the other instance. - -The smolmain() function should contain code to create a new instance based on -the parameters passed. - -IPC should be done with QLocalSocket. - -### Dockable windows - -### Folder structure - -- data/ - Any resource files (defaults, icons, etc) -- docs/ - Where all the documentation lives -- src/ - Source code -- test/ - Testing grounds -- tools/ - Hooks, qbs helpers, updater - -### Libraries used -All 3rd-party libraries should be placed in src/3rd-party/library-name, together -with their corresponding license file. The license file should start with the -library name and repository location. - -- tinytoml - ## Components Components should, when possible, be split off into self-contained static libraries. This is to reduce recompile times. @@ -67,16 +23,10 @@ libraries. This is to reduce recompile times. ### Navigation Includes the Address bar (URLLineEdit). -### Bookmarks [TODO] +### Bookmarks - [TODO] Bookmark location should be read from profile, with a default in the config - [TODO] Split off xbel implementation into a library - [TODO] BookmarksLibrary API -### History - -History is managed by QtWebEngine. - -### Cookies - -Cookies are managed by QtWebEngine. +### Downloads diff --git a/docs/manual/Features.md b/docs/manual/Features.md index ead0223..e499fb7 100644 --- a/docs/manual/Features.md +++ b/docs/manual/Features.md @@ -1 +1,3 @@ # Features + +The aim of smolbote is to be a lightweight and fast, to the point web browser. |