aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAqua-sama <aqua@iserlohn-fortress.net>2018-04-02 11:51:36 +0200
committerAqua-sama <aqua@iserlohn-fortress.net>2018-04-02 11:51:36 +0200
commit33360c1f75012bdb22104fd849053055d2147451 (patch)
treeb4232780dd8542b82b233fad981d0aa6e124d279 /README.md
parentPage menus refactoring (diff)
downloadsmolbote-33360c1f75012bdb22104fd849053055d2147451.tar.xz
Updated documentation
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 15 insertions, 7 deletions
diff --git a/README.md b/README.md
index 0044991..99e93d4 100644
--- a/README.md
+++ b/README.md
@@ -2,25 +2,33 @@
_It's yet another no-frills browser, poi!_
### What is this and why should I care?
-The aim is to create a [KISS][kiss-principle] free-software web browser.
+The aim is to create a [keep-it-simple][kiss-principle] free software web browser.
-* small: do one thing and do it well
-* clean: a small codebase of human-readable code
+* do one thing and do it well
+* just work out of the box
* 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.
+This program is free software. You can:
+
+* use it as you see fit;
+* study the source code and change it to suit your needs;
+* share the program;
+* share your modifications.
+
+For more information, and a list of free software we depend on, see [LICENSE.md][repo-license].
### What's up with the name?!
-It's a small boat.
+It's a small boat. It says poi.
### Sounds dumb, how do I use it?
You make it yourself. Then you _poi_.
Do you know what makepkg is? Then take a look in linux/makepkg/.
+Do you know what a compiler is? Great, glance at the [build instructions](/smolbote/building.html).
+
### 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/smolbote.hg/file/tip/LICENSE.md