From 0d26c948b889a1209f251ec9f3e4b8600b33cb28 Mon Sep 17 00:00:00 2001 From: Bastien Nocera Date: Thu, 25 Mar 2021 10:56:14 +0100 Subject: README: Update README And convert it to MarkDown. --- README | 47 ----------------------------------------------- README.md | 30 ++++++++++++++++++++++++++++++ 2 files changed, 30 insertions(+), 47 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 867608c..0000000 --- a/README +++ /dev/null @@ -1,47 +0,0 @@ -General Information -=================== - -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: - http://wiki.gnome.org/Projects/libgudev - -Installation -============ - - % tar xJf libgudev-.tar.xz # unpack the sources - % cd libgudev- # change to the toplevel directory - % ./configure # run the `configure' script - % make # build libgudev - - [ Become root if necessary ] - % make install # install libgudev - -libgudev requires: - >=libudev-199 - >=glib2-2.22.0 - pkg-config - -How to report bugs -================== - -Bugs should be reported to the GNOME bug tracking system. -(http://bugzilla.gnome.org, product libgudev.) You will need -to create an account for yourself. - -Patches -======= - -Patches should also be submitted to bugzilla.gnome.org. If the -patch fixes an existing bug, add the patch as an attachment -to that bug report. - -Otherwise, enter a new bug report that describes the patch, -and attach the patch to that bug report. - -Patches should be in unified diff form. (The -up option to GNU diff.) 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 -- cgit v1.2.1