From f215edb3649e726c9a1de74cc2f1a4018842a4d4 Mon Sep 17 00:00:00 2001 From: Michka Popoff Date: Wed, 22 Jun 2016 21:58:57 +0200 Subject: [PATCH] Improve installation instructions (#31) --- docs/install.rst | 31 +++++++++++++++++++++---------- 1 file changed, 21 insertions(+), 10 deletions(-) diff --git a/docs/install.rst b/docs/install.rst index 0a47758a..fe2f0ade 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -4,7 +4,14 @@ Download & Install Prerequisite: CastXML --------------------- -You need to have `CastXML`_ installed. +`CastXML`_ needs to be installed on your system. + +1) If you are on linux or mac, your package manager may already provide a "castxml" package. + +2) You can download pre-compiled binaries for `Linux`_, for `OS X`_ and for `Windows`_. + +3) You can compile CastXML from source, either with the `SuperBuild`_, or by following the `full install instructions`_ . + Installation of pygccxml ------------------------ @@ -20,19 +27,23 @@ To install from source, you can use the usual procedure: GCC-XML (Legacy) ---------------- -These instructions are only here for historical reasons; `pygccxml` is now using -`CastXML` by default. +These instructions are only here for historical reasons. `GCC-XML`_ was the tool used +to generate the xml files before CastXML existed. -There are few different ways to install `GCC-XML`_ on your system: +**From version v1.8.0 on, pygccxml uses CastXML by default. +The support for GCC-XML will finally be dropped in pygccxml v2.0.0.** -1. If you use Linux, than I am almost sure your system provides the "gccxml" package. - Consider to install it using "native"(rpm, deb, portage) packaging system. +There are few different ways to install GCC-XML on your system: -.. line separator +1) Most Linux system provide the "gccxml" package through their package manager. -2. Another option is to install it from the source code. See the `instructions`_ here. - Installation from sources supported for Windows, Linux and Mac platforms. +2) See the `instructions`_ to install GCC-XML from source. -.. _`instructions` : http://gccxml.org/HTML/Install.html +.. _`instructions`: http://gccxml.org/HTML/Install.html .. _`GCC-XML`: http://www.gccxml.org .. _`CastXML`: https://github.com/CastXML/CastXML +.. _`Linux`: https://midas3.kitware.com/midas/download/bitstream/460535/castxml-linux.tar.gz +.. _`OS X`: https://midas3.kitware.com/midas/download/bitstream/460536/castxml-macosx.tar.gz +.. _`Windows`: https://midas3.kitware.com/midas/download/bitstream/460537/castxml-windows.zip +.. _`SuperBuild`: https://github.com/thewtex/CastXMLSuperbuild +.. _`full install instructions`: https://github.com/CastXML/CastXML#build