diff --git a/README.md b/README.md index ab733a48..e2354c15 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ support. * [Frequently asked questions (FAQ)](doc/FAQ.md) * [Hello world](example/hello/README.md) * [Changelog](CHANGELOG.md) - * [Installation](#installation) + * [Installation](doc/INSTALL.md) * [Licenses](#licenses) * [Support](#support) * [Dependencies](#dependencies) @@ -47,21 +47,6 @@ Users of Clixon currently include: See also [Clicon project page](http://clicon.org). -Clixon runs on Linux, [FreeBSD port](https://www.freshports.org/devel/clixon) and Mac/Apple. CPU architecures include x86_64, i686, ARM32. - -## Installation - -A typical installation is as follows: -``` - configure # Configure clixon to platform - make # Compile - sudo make install # Install libs, binaries, and config-files - sudo make install-include # Install include files (for compiling) -``` - -One [example application](example/README.md) is provided, a IETF IP YANG datamodel with -generated CLI, Netconf and restconf interface. - ## Licenses Clixon is open-source and dual licensed. Either Apache License, Version 2.0 or GNU diff --git a/doc/INSTALL.md b/doc/INSTALL.md new file mode 100644 index 00000000..6efca64f --- /dev/null +++ b/doc/INSTALL.md @@ -0,0 +1,47 @@ +# Building Clixon + +Clixon runs on Linux, [FreeBSD port](https://www.freshports.org/devel/clixon) and Mac/Apple. CPU architecures include x86_64, i686, ARM32. + +## Ubuntu Linux + +### Installing dependencies + +Install packages +``` +sudo apt-get update +sudo apt-get install flex bison fcgi-dev curl-dev +``` + +Install and build CLIgen +``` + git clone https://github.com/olofhagsand/cligen.git + cd cligen; + configure; + make; + make install +``` + +Add a user group, using groupadd and usermod: +``` + sudo groupadd clicon # + sudo usermod -a -G clicon + sudo usermod -a -G clicon www-data +``` + + +### Build from source +``` + configure # Configure clixon to platform + make # Compile + sudo make install # Install libs, binaries, and config-files + sudo make install-include # Install include files (for compiling) +``` + +## Alpine Linux +Docker is used to build Alpine Linux +### Build docker image + +## FreeBSD +### Package install +### Build from source +