From 5466a32fda5f4031f82ab90339adf29a6a728985 Mon Sep 17 00:00:00 2001 From: Daniil Baturin Date: Mon, 29 Jul 2019 17:50:18 -0400 Subject: Document the build procedure. --- README | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/README b/README index 9ea9c66..925e954 100644 --- a/README +++ b/README @@ -5,9 +5,23 @@ This library mixes the multiway tree manipulation libraries from [vyconf](https: with a parser and a formatter for VyOS 1.x config format, and is meant to be used in config migration scripts and analysis/conversion tools. -It is not really properly packaged now and has undeclared build dependencies on VyConf (obviously) and also -assumed that OCaml installation is per-user (through opam) rather than system-wide. - The main purpose is to provide bindings for Python, so using this library directly from C is strongly -discourages: not just the interface is not guaranteed to be stable, it's written to be a bridge between +discouraged: not just the interface is not guaranteed to be stable, it's written to be a bridge between two high level languages so it would be very inconvenient to use from C. + +## Building + +You need to install OPAM and then use it to install OCaml (latest 4.08 works fine). + + +``` +# Clone and install the vyos1x-config library +git clone https://github.com/vyos/vyos1x-config +opam pin add vyos1x-config . + +# Install build deps +opam install ctypes ctypes-foreign ctypes-build + +# Build the Debian package +dpkg-buildpackage -b -us -uc -tc +``` -- cgit v1.2.3