* doc/Makefile.am: New dependencies. * doc/license_commercial.dox, * doc/mainpage.dox, * doc/modules_list.dox: More content. * doc/get_sources.dox, * doc/online_resources.dox: New. --- ChangeLog | 13 +++++++++++++ doc/Makefile.am | 2 ++ doc/get_sources.dox | 37 +++++++++++++++++++++++++++++++++++++ doc/license_commercial.dox | 5 +++-- doc/mainpage.dox | 4 ++-- doc/modules_list.dox | 2 +- doc/online_resources.dox | 34 ++++++++++++++++++++++++++++++++++ 7 files changed, 92 insertions(+), 5 deletions(-) create mode 100644 doc/get_sources.dox create mode 100644 doc/online_resources.dox diff --git a/ChangeLog b/ChangeLog index 2344721..5379982 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,16 @@ +2011-10-28 Guillaume Lazzara <z@lrde.epita.fr> + + Add more content in general documentation. + + * doc/Makefile.am: New dependencies. + + * doc/license_commercial.dox, + * doc/mainpage.dox, + * doc/modules_list.dox: More content. + + * doc/get_sources.dox, + * doc/online_resources.dox: New. + 2012-02-27 Guillaume Lazzara <z@lrde.epita.fr> Add details about licensing. diff --git a/doc/Makefile.am b/doc/Makefile.am index 410316b..81c34b1 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -64,6 +64,8 @@ REFMAN_deps = $(srcdir)/footer.html \ $(srcdir)/bibliography.dox \ $(srcdir)/license.dox \ $(srcdir)/license_commercial.dox \ + $(srcdir)/online_resources.dox \ + $(srcdir)/get_sources.dox \ contributors.html \ lrde_olena.html diff --git a/doc/get_sources.dox b/doc/get_sources.dox new file mode 100644 index 0000000..23f1446 --- /dev/null +++ b/doc/get_sources.dox @@ -0,0 +1,37 @@ +/*! \page getsources Get the Sources + +If you are interested in developping for Olena, you are definitely +interested in using the development version from our Git Repository. + +To successfuly compile and use the development version, you will need the following additional tools: + +\li Git 1.5 or higher +\li Autoconf 2.61 or higher +\li Automake 1.10 or higher +\li Libtool 1.5.22 or higher +\li Doxygen 1.5.6 or higher +\li ImageMagick 6.3.7 or higher +\li HeVeA 1.10 +\li LaTeX2HTML (or at minimum, its html.sty style file) + +The Git repository is located at git://git.lrde.epita.fr/olena. + +For those who are not used to Git, here are the required commands to get and build a fresh source tree: +\verbatim + git clone git://git.lrde.epita.fr/olena + cd olena + ./bootstrap + mkdir _build + cd _build + ../configure + make +\endverbatim + +The last command may take some time. + +If you want to install Olena, type thereafter (as root): +\verbatim + make install +\endverbatim + +*/ \ No newline at end of file diff --git a/doc/license_commercial.dox b/doc/license_commercial.dox index 0ece2b5..af2f094 100644 --- a/doc/license_commercial.dox +++ b/doc/license_commercial.dox @@ -1,6 +1,7 @@ /*! \page commercial "Commercial Use" - < Under construction > + Even though Olena is released under GPL v2, using Olena in a close + source commercial products may be possible. - Please contact us : olena@lrde.epita.fr + If you are interested, please contact us at olena@lrde.epita.fr */ \ No newline at end of file diff --git a/doc/mainpage.dox b/doc/mainpage.dox index ea15c32..9ebda3b 100644 --- a/doc/mainpage.dox +++ b/doc/mainpage.dox @@ -38,8 +38,8 @@ <tr> <td> \li Report Bugs and Make Suggestions - \li Get the Sources - \li Online Resources + \li \ref getsources + \li \ref onlineres </td> <td> \li \ref gplv2 "GNU GPL" diff --git a/doc/modules_list.dox b/doc/modules_list.dox index e3f2b8d..6b872ef 100644 --- a/doc/modules_list.dox +++ b/doc/modules_list.dox @@ -1,4 +1,4 @@ -/** \page moduleslist List of available modules +/** \page moduleslist List of Available Modules As a platform, Olena is divided in several modules: diff --git a/doc/online_resources.dox b/doc/online_resources.dox new file mode 100644 index 0000000..32cd18d --- /dev/null +++ b/doc/online_resources.dox @@ -0,0 +1,34 @@ +/*! \page onlineres Online Resources + +\section Trac + +In order to keep traces of bugs and feature requests, we provide a +Trac at <a +href="https://trac.lrde.org/olena">https://trac.lrde.org/olena</a>. + +\section Gitweb + +Source code is freely browseable through a web interface at this +address : <a +href="http://git.lrde.epita.fr/?p=olena.git">http://git.lrde.epita.fr/?p=olena.git</a> + +It is also a way to keep an eye on current develop. + +\section BuildBot + +During the development process, we need to be sure that changes don't +break the whole code. To do so, we have a buildfarm running several +architectures and compilers. A monitoring interface is available here +: <a href="https://buildfarm.lrde.org/buildfarm/oln/">https://buildfarm.lrde.org/buildfarm/oln/</a> + +\section Mailing-list + +A general mailing-list is available and open for any questions related +to Olena. You can : + +\li <a href="https://www.lrde.epita.fr/mailman/listinfo/olena">subscribe to our mailing-list</a> +\li <a href="https://www.lrde.epita.fr/pipermail/olena/">fetch the archives of the list</a> +\li send any questions to: <a href="mailto::olena@lrde.epita.fr">olena@lrde.epita.fr</a> + + +*/ \ No newline at end of file -- 1.7.2.5