summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLogan Rathbone <poprocks@gmail.com>2022-07-01 13:59:49 -0400
committerLogan Rathbone <poprocks@gmail.com>2022-07-01 14:01:26 -0400
commit3df081286e91da3e567e7eed64e88f3d148f3daa (patch)
treedbc8eb343f7b8ac81cd20a1429ed0f4477f5f304
parentd3b2a8728d11e3b0466bc7a1abc0c7a9794d5135 (diff)
downloadzenity-3df081286e91da3e567e7eed64e88f3d148f3daa.tar.gz
Rework README as README.md
Remove some of the quirky "zen" tone.
-rw-r--r--README12
-rw-r--r--README.md23
2 files changed, 23 insertions, 12 deletions
diff --git a/README b/README
deleted file mode 100644
index 884bb98..0000000
--- a/README
+++ /dev/null
@@ -1,12 +0,0 @@
-Zen Understanding -
-===================
-This is zenity - a rewrite of gdialog, the GNOME port of dialog
-which allows you to display dialog boxes from the commandline
-and shell scripts. If you understand, things are just as they
-are. If you don't understand, things are just as they are.
-
-This software is licensed under the LGPL.
-
-Zen Requirements -
-==================
-gtk+-3.16
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..57d8a18
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# Zenity
+
+This is Zenity - a rewrite of gdialog, the GNOME port of dialog
+which allows you to display dialog boxes from the commandline
+and shell scripts.
+
+This software is licensed under the LGPL.
+
+Zenity is part of the GNOME Extra Apps family and is not a core
+GNOME application.
+
+## Dependencies
+
+* gtk+-3.16
+
+## Optional Dependencies
+
+* libnotify (for desktop notification support)
+* webkit2gtk-4.1 (for HTML support)
+
+Please see the meson.build file for minimal versions required
+for optional dependencies, and meson_options.txt for the build
+options to enable these features if desired.