aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAqua-sama <aqua@iserlohn-fortress.net>2017-12-19 17:36:09 +0100
committerAqua-sama <aqua@iserlohn-fortress.net>2017-12-19 17:36:09 +0100
commit1c53b56871a36fdf58e58ee87ac6b56d4e3355f0 (patch)
tree1eba5f045a2660a3708b1ec91be838e397cb8335 /README.md
parentBug fixes (diff)
downloadsmolbote-1c53b56871a36fdf58e58ee87ac6b56d4e3355f0.tar.xz
Changed license from GPL3+ to GPL3
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 16 insertions, 8 deletions
diff --git a/README.md b/README.md
index 4a81296..4620bc3 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,26 @@
-## *smolbote*
-_yet another Qt browser_
+## *smolbote?*
+_It's yet another no-frills browser, poi!_
### What is this and why should I care?
-The aim is to create a small, fast and clean web browser.
+The aim is to create a small, clean and tweakable free-software web browser.
-* minimal - just a browser, not a platform
-* configurable - settings in plain sight and plain text
+* small is cute: do one thing and do it well
+* clean: a small codebase of human-readable code
+* tweakable: so you can change all the things
### What's up with the name?!
It's a small boat.
### Sounds dumb, how do I use it?
-You make it yourself after taking a cursory glance at BUILDING.md.
+You make it yourself. Then you _poi_.
+
+Do you know what makepkg is? Then the PKGBUILD is in linux/makepkg/PKGBUILD.
+
+Do you know what a compiler is? Great, then configure qbs and run
+```sh
+qbs build -p poi profile:qt5 release
+```
### It doesn't work, what now?
-Report the bug using the facilities present at the repository. For more
-information, skip over CONTRIBUTING.md.
+For the time being, refer complaints to /dev/null.
+