From 33360c1f75012bdb22104fd849053055d2147451 Mon Sep 17 00:00:00 2001 From: Aqua-sama Date: Mon, 2 Apr 2018 11:51:36 +0200 Subject: Updated documentation --- README.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) (limited to 'README.md') 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 -- cgit v1.2.1