Skip to content

Developer Guide

Tyler Sommer edited this page Dec 28, 2018 · 4 revisions

This page is incomplete.

Contributing

For instructions on contributing to the Unum SDK, check the Contributing Guidelines document that is bundled with the source code.

Overview

The Unum SDK is made of different components:

  • Build scripts written in Makefile and bash
  • Unum agent source code written in C
  • Platform-specific Makefiles and source code
  • Distribution build scripts
    • .deb creation using debhelper
    • Build and runtime containers using Docker
    • Check README-dist.md for additional information.

Additionally, some external components:

  • minim-openwrt-feed for building and installing Unum on devices running OpenWrt.
  • iwinfo-lite, a fork of the OpenWrt utility without uci or ubus.
  • openwrt-builder is used to build pre-configured OpenWrt images and binary packages.

TODO:

  • How to compile, build process
  • Hacking on an installed agent setup