diff options
| author | Jens Georg <mail@jensge.org> | 2021-05-30 13:31:15 +0200 |
|---|---|---|
| committer | Jens Georg <mail@jensge.org> | 2021-06-09 23:55:54 +0200 |
| commit | f6b74234da804fecb17b5ecf2addf68f4d0c58b8 (patch) | |
| tree | 24787a38cc0cae2d4f2e5f5f0fb68b3ff6f31185 | |
| parent | ef283087786540e249d2524a41f9f0b52b948537 (diff) | |
| download | gupnp-f6b74234da804fecb17b5ecf2addf68f4d0c58b8.tar.gz | |
Doc: Improve README.md a bit
| -rw-r--r-- | README.md | 21 |
1 files changed, 18 insertions, 3 deletions
@@ -1,5 +1,4 @@ -GUPnP -===== +# GUPnP GUPnP is an object-oriented open source framework for creating UPnP devices and control points, written in C using GObject and libsoup. The GUPnP API is @@ -21,4 +20,20 @@ threads. GUPnP is entirely single-threaded (though asynchronous), integrates with the GLib main loop, and provides the same set of features as libupnp while hiding most of the UPnP internals through an elegant object-oriented design. -GUPnP is free software released under the GNU LGPL. +GUPnP is free software released under the GNU LGPL version 2.1 or later. + +## Building + +GUPnP uses the meson build system. To build GUPnP, the simplest variant is +``` +$ meson setup build +$ meson compile -C build +``` + +There are several options to customize the build, please see (meson_options.txt) for +a brief overview. + +## Developer documentation + +The developer documentation is available at https://gnome.pages.gitlab.gnome.org/gupnp/docs/ + |