From f5c20e9c9b46ac6efe3c3948302e4e20718a5968 Mon Sep 17 00:00:00 2001 From: Heikki Kallasjoki Date: Tue, 4 Dec 2018 23:26:01 +0000 Subject: Documentation improvements. Include OpenWrt feed and installation instructions, as well as more details (and a README link) on how to contribute to the project. --- README.md | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 55b66ce..801fcef 100644 --- a/README.md +++ b/README.md @@ -35,11 +35,36 @@ You can also use the bundled `Makefile`, which likely requires GNU Make. You can comment out collectors in the Makefile to leave them out of the build if you don't need them. -TODO: OpenWrt feed + package definition + instructions. - The metrics collection is highly Linux-specific. You probably won't have much luck on other operating systems. +### Including in an OpenWrt build + +If you're building an OpenWrt system, you can include this program by +adding the following line to your `feeds.conf` file: + +``` +src-git nanoexporter https://github.com/fis/nano-exporter.git;openwrt +``` + +Then update the feed, and install the package: + +```shell +./scripts/feeds update nanoexporter +./scripts/feeds install -p nanoexporter -a +``` + +The package `nano-exporter` should now be available in `make +menuconfig`, under the "Utilities" heading. + +## Issues and contributions + +Please report any issues on the [GitHub issues +page](https://github.com/fis/nano-exporter/issues). + +See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to +contribute patches and other code. + ## Collectors For the most part, the produced metrics try to loosely (but not -- cgit 1.4.1