summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorDaniil Baturin <daniil@baturin.org>2018-05-26 03:28:36 +0700
committerDaniil Baturin <daniil@baturin.org>2018-05-26 03:28:36 +0700
commit557f45a5a606b8f8ae1630c9f267d31376912746 (patch)
treef981b1ee0655a34399585c7b520619c14ff9a962 /README
downloadlibvyosconfig-557f45a5a606b8f8ae1630c9f267d31376912746.tar.gz
libvyosconfig-557f45a5a606b8f8ae1630c9f267d31376912746.zip
Import the initial, proof of concept implementation.
Diffstat (limited to 'README')
-rw-r--r--README13
1 files changed, 13 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..9ea9c66
--- /dev/null
+++ b/README
@@ -0,0 +1,13 @@
+libvyosconfig
+=============
+
+This library mixes the multiway tree manipulation libraries from [vyconf](https://github.com/vyos/vyconf)
+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
+two high level languages so it would be very inconvenient to use from C.