This repository has been archived on 2024-07-15. You can view files and clone it, but cannot push or open issues or pull requests.
hedera/docs/reference/hedera/configuring.xml

88 lines
3.3 KiB
XML

<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
]>
<refentry id="configuring">
<refmeta>
<refentrytitle>Configuring</refentrytitle>
<manvolnum>0</manvolnum>
<refmiscinfo>Hedera Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>Configuring the Hedera Library</refname>
<refpurpose>
How to configure the Hedera library before start using it
</refpurpose>
</refnamediv>
<refsection id="section-who">
<para>
This chapter covers how to configure the library from the tarball,
if you have received it packed in any other form, like a .deb
package, this section can be ignored, but you'll need to know how
to use the package you received.
</para>
</refsection>
<refsection id="needed">
<title>What do you need?</title>
<para>
The Hedera library has some dependencies, so to compile it you'll
need these to be satisfied. Depending on how many things you want
the library to do, you'll need more or less things to start using
it.
</para>
<para>
The main and unavoidable dependencies for the Hedera library
are GLib and GTK+. Also, depending of what type of database you will
be using, you will also need the public API of this database. The
goal of the library is to add more support for other free databases,
but right now, the only supported databases are PostgreSQL and
MySQL, so you will need to install the programming interface for at
least of of these.
</para>
<para>
If you want to generate this documentation with your own compilation
of the library, you'll also need to install GTK-Doc to do so.
</para>
</refsection>
<refsection id="compiling">
<title>Compiling the library</title>
<para>
Supposing you've satisfied all of the existing dependencies, now
you'll need to compile the Hedera library. To do it you just have
to go to the root folder of the library and run the autogen.sh
script with the configure options of your choice (listed in the
README file of the distribution) e.g. './autogen.sh --enable-vala
--prefix=~/installdir' and then run 'make' to compile the library.
</para>
<para>
As we do, we highly recommend developers using the Hedera
library and also GTK+ or GLib, to use the Anjuta IDE, a very
useful and complete free developing environment with a great
support and integration for the GObject system and the GNU
build system.
</para>
</refsection>
<refsection id="vala">
<title>Vala</title>
<para>
The Hedera library supports Vala as programming language. If
you will be programming in Vala, you must install the Vala
compiler, valac. The only version of Vala supported right now is
the 0.16, plans are to be also compatible with newer versions
too. Note that to build the Vala bindings you'll also need the
vapigen tool, which normally installs with the Vala compiler.
</para>
</refsection>
<refsection id="installing">
<title>Installing</title>
<para>
When you have the library configured according to your needs,
you'll have to execute 'make install' with root privileges, and
the library directory tree will install in the folder specified
at configure time.
</para>
</refsection>
</refentry>