From 8d9fbecd1fdd2821160cfa198d912163d59b0dcc Mon Sep 17 00:00:00 2001 From: Aaron Rosen Date: Thu, 19 Sep 2013 11:01:26 -0700 Subject: [PATCH] Cleanup README and add build instructions This patch cleans up the README file to match that of openstack-manuals and adds build instuctions. Change-Id: I77000420bac19fad375d04adf3c0dacf20df65d4 --- README.rst | 45 ++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 42 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 50bb4d3..e5a794f 100644 --- a/README.rst +++ b/README.rst @@ -1,9 +1,48 @@ -This repository contains the RESTful API information for the OpenStack Network Connectivity project, also known as Neutron. The Neutron project provides open source network connectivity to OpenStack Compute, the project named Nova. +Netconn API ++++++++++++ + +This repository contains the RESTful API information for the OpenStack Network +Connectivity project, also known as Neutron. The Neutron project provides open +source network connectivity to OpenStack Compute, the project named Nova. Contributing ============ -Our community welcomes all people interested in open source cloud computing, and there are no formal membership requirements. The best way to join the community is to talk with others online or at a meetup and offer contributions through Launchpad, the OpenStack wiki, or blogs. We welcome all types of contributions, from blueprint designs to documentation to testing to deployment scripts. +Our community welcomes all people interested in open source cloud computing, +and there are no formal membership requirements. The best way to join the +community is to talk with others online or at a meetup and offer contributions +through Launchpad, the OpenStack wiki, or blogs. We welcome all types of +contributions, from blueprint designs to documentation to testing to deployment +scripts. + +Prerequisites +============= +`Apache Maven `_ must be installed to build the +documentation. + +To install Maven 3 for Ubuntu 12.04 and later,and Debian wheezy and later:: + + apt-get install maven + +On Fedora 15 and later:: + + yum install maven3 + +Building +======== +To build:: + + cd netconn-api + mvn clean generate-sources + +The generated PDF documentation file is:: + + netconn-api/target/docbkx/webhelp/api/openstack-network/2.0/neutron-api-guide-2.0.pdf + +The root of the generated HTML documentation is:: + + netconn-api/target/docbkx/webhelp/api/openstack-network/2.0/index.html Installing ========== -Refer to http://docs.openstack.org/incubation to learn more about installing OpenStack Neutron so that you can test these API commands. +Refer to http://docs.openstack.org to see where these documents are published +and to learn more about the OpenStack project.