Commit 186aa31b authored by Ales Mrazek's avatar Ales Mrazek Committed by Ales Mrazek

Readme update

parent 43077946
...@@ -18,20 +18,66 @@ Python 3. Main features: ...@@ -18,20 +18,66 @@ Python 3. Main features:
* Support for NACM_ * Support for NACM_
Prerequisites
=============
*JetConf* requires Python 3.5
```
$ sudo apt-get install python3
$ sudo apt-get install python3-pip
```
These requirements should be installed by running *Instalation*
```
colorlog==2.10.0
h2==3.0.1
hpack==2.3.0
hyperframe==5.0.0
pyaml==16.12.2
pytz==2016.10
PyXB==1.2.5
PyYAML==3.12
yangson==1.3.16
```
Installation Installation
============ ============
:: ```
$ python3 -m pip install jetconf
python -m pip install jetconf ```
Note that *JetConf* requires Python 3.5. Note that *JetConf* requires Python 3.5.
Running
============
Running JetConf
```
$ cd jetconf
$ ./run.py -c <path_to_config_file.yaml>
```
Example configuration (template)
============
In folder 'data' is example template for configuring paths, certificates etc.
example config file
```
example-config.yaml
```
In this configuration file you have to setup paths.
Links Links
===== =====
* `Git repository`_ * `Git repository`_
* `Documentation`_ * `Documentation`_
.. _RESTCONF: https://tools.ietf.org/html/draft-ietf-netconf-restconf-18 .. _RESTCONF: https://tools.ietf.org/html/draft-ietf-netconf-restconf-18
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment