summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBastien Nocera <hadess@hadess.net>2021-03-25 10:56:14 +0100
committerBastien Nocera <hadess@hadess.net>2021-03-25 10:56:34 +0100
commit0d26c948b889a1209f251ec9f3e4b8600b33cb28 (patch)
tree4b5b3e64508b674f3490c9947e2b422074bff9cf /README.md
parente4a0b196615690e4c1910af3cd57872af4f8e2ec (diff)
downloadlibgudev-0d26c948b889a1209f251ec9f3e4b8600b33cb28.tar.gz
README: Update README
And convert it to MarkDown.
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d5b26d5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+libgudev
+========
+
+This is libgudev, a library providing GObject bindings for libudev. It
+used to be part of udev, then merged into systemd. It's now a project
+on its own.
+
+The official download locations are:
+ http://download.gnome.org/sources/libgudev
+
+The official web site is:
+ https://gitlab.gnome.org/GNOME/libgudev/
+
+Installation
+------------
+
+libgudev uses [meson](https://mesonbuild.com/) as its build system, so
+[generic installation instructions](https://mesonbuild.com/Quick-guide.html#compiling-a-meson-project)
+apply to installing libgudev.
+
+libgudev requires `libudev` (part of systemd), glib, and pkg-config. Refer to
+the `meson.build` file itself for up-to-date version requirements.
+
+libgudev also optionally uses [umockdev](https://github.com/martinpitt/umockdev)
+for its tests.
+
+Bugs and patches
+----------------
+
+Bugs and patches can be contributed on [the project's GitLab page](https://gitlab.gnome.org/GNOME/libgudev/). \ No newline at end of file