diff options
| -rw-r--r-- | README.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..b2a3755 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# homematic-go + +This is a Go library to use homematic devices. + +## Usage + +This repository can be used as any other Go library. + +Furthermore it uses the Meson build system. An example program can be built +with `meson` and `ninja`. + +``` +meson setup build +ninja -C build +``` + +In addition to the default target specific ones can be specified with `ninja`. + +``` +ninja -C build <target> +``` + +These targets are currently supported: + +- `run` build and run the example program +- `test` runs the unit test suite |