diff options
| author | Aqua-sama <aqua@iserlohn-fortress.net> | 2018-10-03 17:00:18 +0200 |
|---|---|---|
| committer | Aqua-sama <aqua@iserlohn-fortress.net> | 2018-10-03 17:00:18 +0200 |
| commit | 33621f2c537b996d37abbd7e143716d439143caf (patch) | |
| tree | 7f7477e7e1ef64f0f5c3f3b2644484d8c1db0b0b /README.md | |
| parent | Convert documentation into asciidoc from markdown (diff) | |
| download | smolbote-33621f2c537b996d37abbd7e143716d439143caf.tar.xz | |
Update pkgbuild
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..60c9a2d --- /dev/null +++ b/README.md @@ -0,0 +1,50 @@ +## *smolbote?* +_It's yet another no-frills browser, poi!_ + +### What is this and why should I care? +smolbote is a [keep-it-simple][kiss-principle] free software web browser based +on Qt and QtWebEngine. + +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 [LICENSE.md][repo-license]. + +#### 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. + +### 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 [build instructions](/smolbote/building.html) also included. + +### It doesn't work, what now? +Drop me an email at _aqua at iserlohn dash fortress dot net_. + +[kiss-principle]: https://en.wikipedia.org/wiki/KISS_principle +[repo-license]: https://neueland.iserlohn-fortress.net/gitea/aqua/smolbote/src/branch/master/LICENSE.md |