diff options
author | Marc-André Lureau <marcandre.lureau@redhat.com> | 2019-05-07 17:34:07 +0200 |
---|---|---|
committer | Marc-André Lureau <marcandre.lureau@redhat.com> | 2019-05-07 17:47:46 +0200 |
commit | 78d3a36c9fd9679499054384a25e1985968b794e (patch) | |
tree | fb74ffbd4abb0510aad543f9a7fa34e8ff2df85f /README.md | |
parent | 2b929468d66c9a7c952f33fdef522ba63f562003 (diff) | |
download | slirp-78d3a36c9fd9679499054384a25e1985968b794e.zip slirp-78d3a36c9fd9679499054384a25e1985968b794e.tar.gz slirp-78d3a36c9fd9679499054384a25e1985968b794e.tar.bz2 |
Add a README.md file
Fixes:
https://gitlab.freedesktop.org/slirp/libslirp/issues/7
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..28fd9af --- /dev/null +++ b/README.md @@ -0,0 +1,58 @@ +# libslirp + +libslirp is a user-mode networking library used by virtual machines, +containers or various tools. + +## Getting Started + +### Prerequisites + +A C compiler, make/meson and glib2 development libraries. + +(see also [.gitlab-ci.yml](.gitlab-ci.yml) DEPS variable for the list +of dependencies on Fedora) + +### Building + +QEMU uses a static library built with ``make``. But you may also build +and install the shared library with meson: + +``` sh +meson build +ninja -C build install +``` + +### Testing + +Unfortunately, there are no automated tests available. + +You may run QEMU ``-net user`` linked with your development version. + +## Contributing + +Feel free to open issues on the [project +issues](https://gitlab.freedesktop.org/slirp/libslirp/issues) page. + +You may clone the [gitlab +project](https://gitlab.freedesktop.org/slirp/libslirp) and create a +merge request. + +Contributing with gitlab allows gitlab workflow, tracking issues, +running CI etc. + +Alternatively, you may send patches to slirp@lists.freedesktop.org +mailing list. + +## Versioning + +We intend to use [libtool's +versioning](https://www.gnu.org/software/libtool/manual/html_node/Updating-version-info.html) +for the shared libraries and use [SemVer](http://semver.org/) for +project versions. + +For the versions available, see the [tags on this +repository](https://gitlab.freedesktop.org/slirp/libslirp/releases). + +## License + +See the [COPYRIGHT](COPYRIGHT) file for details. |