[libhttpseverywhere] readme: doc instructions and packaging badge
- From: Daniel Brendle <elbren src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libhttpseverywhere] readme: doc instructions and packaging badge
- Date: Sat, 23 Sep 2017 12:47:42 +0000 (UTC)
commit f1a73f8454461cb93ae88ce54663871e1be4cfd0
Author: grindhold <grindhold gmx net>
Date: Sat Sep 23 14:46:36 2017 +0200
readme: doc instructions and packaging badge
* we now display a repology badge to demonstrate where
our package has found a home in
* clearer instructions about building docs
README.md | 10 +++++++++-
1 files changed, 9 insertions(+), 1 deletions(-)
---
diff --git a/README.md b/README.md
index 7f26729..44a1b15 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,8 @@
libhttpseverywhere
==================
+[![Packaging
status](https://repology.org/badge/vertical-allrepos/libhttpseverywhere.svg)](https://repology.org/metapackage/libhttpseverywhere)
+
This library enables you to leverage the power of
[HTTPSEverywhere](https://www.eff.org/https-everywhere) to any desktop-application you want
@@ -22,7 +24,6 @@ Documentation
-------------
You can either generate the documentation as a devhelp-book for yourself (see Building-section)
-or you can browse them online: [httpseverywhere-0.2 API docs](http://grindhold.de/httpseverywhere-0.2/)
Dependencies
------------
@@ -65,6 +66,13 @@ $ meson build && cd build
$ ninja
```
+If you want to build the documentation, make sure you have valadoc available
+on your system and call meson like this:
+
+```
+meson -Denable_valadoc=true build && cd build
+```
+
If you desire to install the library, execute:
```
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]