Documentation change only: add Quick Start Guide section to main README.md.
@@ -153,6 +153,23 @@ Configuration information for the examples and the tests can be found in the `cf
| Wi-Fi | The [sockets](/example/sockets "sockets example") example brings up a TCP/UDP socket by using the [device](/common/device "device API"), [network](/common/network "network API") and [sock](/common/sock "sock API") APIs. |
| GNSS | [location](/example/location "location example") example using a GNSS chip connected directly or via a cellular module.|
+# Quick Start Guide
+It is easy to get started with `ubxlib` using the [examples](/example) listed above and the build files in this repository as a basis.
+
+A step-by-step description of how to get started with an application based on `ubxlib` is given below:
+- Copy the source files for the [example](/example) that is closest to your intended application to your project directory.
+- Remove all definitions and include files that are related purely to the `ubxlib` test system; for example you only need to include the [ubxlib.h](/ubxlib.h) file and you will want the entry point to be something like `int main()` rather than `U_PORT_TEST_FUNCTION(...)`.
+- Adapt the definitions needed for your example, see the include file `u_cfg_app_platform_specific.h` for your platform; some examples of definitions that need to be set are:
+ - UART number and UART pins to use for connecting the MCU to the target module,
+ - network credentials (e.g. Wi-Fi SSID and password).
+- Copy the make or cmake files from the `runner` directory of the port ([port/platform/](/port/platform/)) of your chosen MCU and adapt them to your application:
+ - point out the `ubxlib` directory by setting the `UBXLIB_BASE` variable,
+ - remove any definitions related to the `ubxlib` test environment as you wish,
+ - if needed, add the source file(s) of your application to the make/cmake files.
+- Build and flash your adapted example using your IDE of choice or command-line make/cmake.
+
+General information about the build system is available in the [port directory](/port) and platform specific information is available in the [platform specific port directory](/port/platform) for your chosen MCU.
+
# Feature Request And Roadmap
New features can be requested and up-voted [here](https://github.com/u-blox/ubxlib/issues/12). The comments of this issue also contains an outlook about features of upcoming releases. Also it is the right place to discuss features and their priority.
