openstack
/
fuel-docs
Code Issues Proposed changes

Merge pull request #87 from e0ne/readme-fix 

Updated Reamde to setup environment
This commit is contained in:
Mike Scherbakov 2013-12-09 05:30:21 -08:00
parent 62206825cd 28cb6f905d
commit 395ab0cbf3
1 changed files with 13 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -1,10 +1,10 @@
FUEL™ for OpenStack Documentation Mirantis OpenStack Documentation
================================= =================================
This repository contains the FUEL™ for OpenStack user and administrator This repository contains the Mirantis OpenStack user and administrator
guides. For more details, see the [FUEL™ for OpenStack guides. For more details, see the [Mirantis OpenStack
portal](http://fuel.mirantis.com "FUEL™ for OpenStack portal"). portal](http://software.mirantis.com "Mirantis OpenStack portal").
Contributing Contributing
============ ============
@ -26,17 +26,13 @@ Documentation Generator") must be installed to build the documentation.
Please note that easy_install is a component of Python's Setup Tools Please note that easy_install is a component of Python's Setup Tools
package, which is commonly an optional install on most distributions. package, which is commonly an optional install on most distributions.
To get started, you need to install Sphinx and necessary extensions:
sudo easy_install -U Sphinx To get started, you need to install all necesasary tools:
sudo easy_install -U cloud_sptheme sudo apt-get install git python-pip python-dev make imagemagick libjpeg-dev
sudo easy_install -U sphinxcontrib-fancybox
sudo easy_install -U rst2pdf And Sphinx necessary extensions:
sudo easy_install -U sphinxcontrib-blockdiag
sudo easy_install -U sphinxcontrib-actdiag sudo pip install -r requirements.txt
sudo easy_install -U sphinxcontrib-seqdiag
sudo easy_install -U sphinxcontrib-nwdiag
sudo easy_install -U sphinxcontrib-plantuml
In addition to these eggs you will need to install In addition to these eggs you will need to install
[PlantUML](http://plantuml.sourceforge.net/ "PlantUML") and [PlantUML](http://plantuml.sourceforge.net/ "PlantUML") and
@ -48,6 +44,9 @@ To install PlantUML you run this wget process:
http://sourceforge.net/projects/plantuml/files/plantuml.jar/download \ http://sourceforge.net/projects/plantuml/files/plantuml.jar/download \
-O /sbin/plantuml.jar -O /sbin/plantuml.jar
PlantumUML requires java:
sudo apt-get install openjdk-7-jre
To edit SVG images we use [Inkscape](http://inkscape.org/ "Inkscape") but To edit SVG images we use [Inkscape](http://inkscape.org/ "Inkscape") but
you may use any other SVG-capable tool you like. We're not picky. you may use any other SVG-capable tool you like. We're not picky.