aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAqua-sama <aqua@iserlohn-fortress.net>2018-01-05 20:23:33 +0100
committerAqua-sama <aqua@iserlohn-fortress.net>2018-01-05 20:23:33 +0100
commit72b15842815566c46b9e770915fa917d41e7fe89 (patch)
tree132e5ef83fca501b436003838c0bf21fb6bc961b /README.md
parentVarious minor fixes (diff)
downloadsmolbote-72b15842815566c46b9e770915fa917d41e7fe89.tar.xz
Updated ReadMe and pkgbuild
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 12 insertions, 9 deletions
diff --git a/README.md b/README.md
index 4620bc3..d7bcd68 100644
--- a/README.md
+++ b/README.md
@@ -2,11 +2,15 @@
_It's yet another no-frills browser, poi!_
### What is this and why should I care?
-The aim is to create a small, clean and tweakable free-software web browser.
+The aim is to create a [KISS](kiss-principle) free-software web browser.
-* small is cute: do one thing and do it well
+* small: do one thing and do it well
* clean: a small codebase of human-readable code
-* tweakable: so you can change all the things
+* tweakable: you can change all the things
+
+This is free software. You can use it as you see fit, studay the source code
+and change it to suit your needs, and share the program, with or without
+modification. For more information, see LICENSE.md.
### What's up with the name?!
It's a small boat.
@@ -14,13 +18,12 @@ It's a small boat.
### Sounds dumb, how do I use it?
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 makepkg is? Then take a look in linux/makepkg/.
-Do you know what a compiler is? Great, then configure qbs and run
-```sh
-qbs build -p poi profile:qt5 release
-```
+Do you know what a compiler is? Great, glance at docs/manual/Building.md for
+instructions.
### It doesn't work, what now?
-For the time being, refer complaints to /dev/null.
+Drop me an email at _aqua at iserlohn-fortress.net_.
+[kiss-principle]: https://en.wikipedia.org/wiki/KISS_principle