diff options
Diffstat (limited to 'Readme.asciidoc')
-rw-r--r-- | Readme.asciidoc | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/Readme.asciidoc b/Readme.asciidoc new file mode 100644 index 0000000..2434561 --- /dev/null +++ b/Readme.asciidoc @@ -0,0 +1,48 @@ +== *smolbote?* +_It's yet another no-frills browser, poi!_ + +=== What is this and why should I care? +smolbote is a link:https://en.wikipedia.org/wiki/KISS_principle[keep-it-simple] +free software web browser based on Qt and QtWebEngine. + +==== Simplicity +This should be a simple browser that only does its browsing job with as little +fuss as possible. This is not a platform. + +==== Customizability +This browser should be usable with minimal configuration necessary. At the same +time, all functionality should be user-customizable. It is the user's +responsibility to ensure a stable working state when changing settings. + +This browser should be kept as platform-agnostic as possible, while learning +from and implementing the UNIX philosophy as applicable. + +==== Pragmatic Freedom +Free software should serve the user, not impose unbreakable barriers for +ideological reasons. + +QtWebEngine allows the usage of third-party non-free codecs and non-free +plugins. This browser does not prevent you from doing so. It's up to you how +you exercise your freedom. + +This program is free software. You can use it as you see fit, study and modify +it, and share the program with or without modification, but providing the same +terms. + +For more information, and a list of dependancies, see the license information +included in the repository. + +=== What's up with the name?! +It's a small boat. It says poi. + +=== Sounds dumb, how do I use it? +You make it yourself. + +It's a cmake-based project that depends on Qt and Boost, so cmake && make alone +should be sufficient to build from source. Some basic package scripts are +provided in the repository. + +Detailed link:/smolbote/building.html[build instructions] also included. + +=== It doesn't work, what now? +Drop me an email at _aqua at iserlohn dash fortress dot net_. |