experiments/clixon
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

added template doc/INSTALL.md

Browse source
This commit is contained in:
Olof hagsand 2019-06-18 10:07:17 +02:00
parent e5a1c821e9
commit 73d8e97a01
2 changed files with 48 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -10,7 +10,7 @@ support.
* [Frequently asked questions (FAQ)](doc/FAQ.md) * [Frequently asked questions (FAQ)](doc/FAQ.md)
* [Hello world](example/hello/README.md) * [Hello world](example/hello/README.md)
* [Changelog](CHANGELOG.md) * [Changelog](CHANGELOG.md)
* [Installation](#installation) * [Installation](doc/INSTALL.md)
* [Licenses](#licenses) * [Licenses](#licenses)
* [Support](#support) * [Support](#support)
* [Dependencies](#dependencies) * [Dependencies](#dependencies)
@ -47,21 +47,6 @@ Users of Clixon currently include:
See also [Clicon project page](http://clicon.org). 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 ## Licenses
Clixon is open-source and dual licensed. Either Apache License, Version 2.0 or GNU Clixon is open-source and dual licensed. Either Apache License, Version 2.0 or GNU

47
doc/INSTALL.md Normal file
View file

@ -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 <user>
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