summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRoy Marples <roy@marples.name>2017-03-14 22:36:41 +0000
committerRoy Marples <roy@marples.name>2017-03-14 22:36:41 +0000
commit296e2763eb84a216bc8778efe1f2e564aff914db (patch)
tree3fb46c7d559b2b33613275dc480736522c07bd7e
parentbde45e1e3a8db47dc1a8388d52037a3150b83581 (diff)
downloaddhcpcd-ui-296e2763eb84a216bc8778efe1f2e564aff914db.tar.xz
Add some markdown loving.
-rw-r--r--README.md (renamed from README)21
1 files changed, 14 insertions, 7 deletions
diff --git a/README b/README.md
index 98623c6..d898ac8 100644
--- a/README
+++ b/README.md
@@ -1,4 +1,7 @@
-dhcpcd-ui is the graphical interface to dhcpcd-5.x
+# dhcpcd-ui
+
+dhcpcd-ui is the graphical interface to
+[dhcpcd](http://roy.marples.name/projects/dhcpcd).
It has a helper library in C to try and minimize any toolkit
specific parts.
@@ -9,12 +12,16 @@ an EFL (e17) front end is planned.
dhcpcd-online can report on network availability from dhcpcd
(requires dhcpcd-6.4.4)
+---
+
+## Build options
+
Switches to control building of various parts:
- --with-dhcpcd-online
- --with-gtk
- --with-qt
- --with-icons
- --enable-notification
-For each --with there is a --without and for each --enable a --disable.
+ * `--with-dhcpcd-online`
+ * `--with-gtk`
+ * `--with-qt`
+ * `--with-icons`
+ * `--enable-notification`
+For each `--with` there is a `--without` and for each `--enable` a `--disable`.
If each part is not specified then the configure will test the system
for the needed libraries to build and install it.