From 57518950ea637660b10e8d6205f5e4b1373577ad Mon Sep 17 00:00:00 2001 From: Dan Williams Date: Fri, 9 Feb 2024 09:29:51 -0600 Subject: [PATCH] README.md: add a short "Getting Started" section for how-to-build Help out people that may never have used Meson or built ModemManager before. Signed-off-by: Dan Williams --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 2b34f063..2aee9579 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,22 @@ ModemManager provides a unified high level API for communicating with mobile broadband modems, regardless of the protocol used to communicate with the actual device (Generic AT, vendor-specific AT, QCDM, QMI, MBIM...). +## Getting Started + +ModemManager uses the meson build system. Meson is likely available as a +package from your Linux distrubtion, but if not please refer to the [Meson +project](https://mesonbuild.com/Quick-guide.html) for installation instructions. Once you have Meson installed you'll +probably want to install [libmbim](https://gitlab.freedesktop.org/mobile-broadband/libmbim) and [libqmi](https://gitlab.freedesktop.org/mobile-broadband/libqmi) which most modems require. + +After dependencies are installed you can build ModemManager with: + + $ meson setup build --prefix=/usr --buildtype=release + $ ninja -C build + +And after a successful build, install with: + + $ sudo ninja -C build install + ## Using ModemManager is a system daemon and is not meant to be used directly from