mirror_ifupdown2/docs/source/gettingstarted.rst
Roopa Prabhu 904908bc5f Documentation cleanup
Ticket:
Reviewed By:
Testing Done:

- these changes are mainly related to api doc generation using sphinx
2014-07-22 11:15:56 -07:00

28 lines
704 B
ReStructuredText

Getting Started
===============
Prerequisites
-------------
* python-ifupdown2 is currently only tested on debian wheezy
* python-ifupdown2 needs python version 2.6 or greater
* build depends on: python-stdeb (for deb builds), python-docutils (for rst2man)
* depends on python-gvgen package for printing interface graphs (this will be made optional in the future)
* optional dependency for template engine: python-mako
* python-ifupdown2 needs python-ifupdown2-addons to function correctly
Building
--------
$git clone <ifupdown2 git url> ifupdown2
$cd ifupdown2/ifupdown2
$./build.sh
Installing
----------
install generated python-ifupdown2-<ver>.deb
$dpkg -i <python-ifupdown2-addons-<ver>.deb