aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAqua-sama <aqua@iserlohn-fortress.net>2018-08-10 16:22:56 +0200
committerAqua-sama <aqua@iserlohn-fortress.net>2018-08-18 11:13:59 +0200
commit60c0c1e6ccad41190dfe1f7dbd47a7d1974427d0 (patch)
tree8dc11e8cfa74bfa6f1b8d3c74aa34f71537194f1 /README.md
parentAddressBar: prevent URL formatting caused by context menu (diff)
downloadsmolbote-60c0c1e6ccad41190dfe1f7dbd47a7d1974427d0.tar.xz
Update readme
Update configuration summary
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 13 insertions, 16 deletions
diff --git a/README.md b/README.md
index caed187..ac735d1 100644
--- a/README.md
+++ b/README.md
@@ -2,33 +2,30 @@
_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.
+smolbote is a [keep-it-simple][kiss-principle] free software web browser based
+on Qt and QtWebEngine.
-* do one thing and do it well
-* just work out of the box
-* tweakable: you can change all the things
+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.
-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].
+For more information, and a list of dependancies, see [LICENSE.md][repo-license].
### 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. Then you _poi_.
+You make it yourself.
-Do you know what makepkg is? Then take a look in linux/makepkg/.
+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.
-Do you know what a compiler is? Great, glance at the [build instructions](/smolbote/building.html).
+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/smolbote.hg/file/tip/LICENSE.md
+[repo-license]: https://neueland.iserlohn-fortress.net/gitea/aqua/smolbote/src/branch/master/LICENSE.md
+