= Getting EKG2 =

== Distribution-specific packages ==
Many distros can have EKG2 in standard repos, but probably only 'stable' releases or very old snapshots. You'd probably like to use newer version instead. Below is a list of distro-specific, officially appreciated by authors packages. If your distro isn't listed below, you'll probably have to build EKG2 yourself, alien other distro's package or install portage.

=== Gentoo Linux ===
Official SVN ekg2 Gentoo ebuild can be found in [http://svn.mgorny.i-rpg.net/emdzientoo/trunk/ emdzientoo overlay]. To add it easily:
{{{
layman -fo http://svn.mgorny.i-rpg.net/emdzientoo/trunk/layman.xml -a emdzientoo
}}}

=== Microsoft® Windows® ===
Currently support of Microsoft® Windows® systems is very limited. You'd probably want to run EKG2 on some POSIX shell and use SSH instead.

You can also try these EKG2 builds:
  * [http://pl.ekg2.org/win32/ekg2-win32-20080824-more-plugs.tar.bz2 darkjames' MinGW build] - GTK+ UI, irc, jabber, polchat; doesn't work under wine;
  * [http://dl.getdropbox.com/u/26824/ekg2-cygwin.7z PiotrLegnica's cygwin build] - ncurses (with artifacts?), gg, irc, jabber, logs…

== Fetching fresh sources ==

=== Directly from SVN ===
{{{
svn co http://toxygen.net/svn/ekg2/trunk ekg2
}}}

=== Official snapshots ===
If you don't want to install subversion or have limited disk space, you may also download snapshot generated every midnight from [http://ekg2.org/download.php download page].

The snapshots are generated using autotools, thus contain limited amount of files.

=== Unofficial snapshots ===
More complete snapshots can be also found in [http://mgorny.i-rpg.net/ekg2/ mgorny's snapshots].

== Compiling using autotools ==
Autotools is basic, officially supported method of compiling EKG2.

=== Compiling snapshot ===
If you've downloaded EKG2 source snapshot, then all hard work has been already performed for you. You'll just have to run:
{{{
./configure <CONFIGURE_OPTS>
make
make install
}}}

To get info on configure options, use:
{{{
./configure --help
}}}

=== Compiling SVN ===
You'll have to have full autotools set installed (aclocal, autoconf, automake), gettext with 'autopoint' and libtool with 'libtoolize'. If 'autopoint' is unavailable (it required cvs installed, don't ask us why), autogen.sh will try to use 'gettextize' instead, but it may fail and is unsupported.

{{{
./autogen.sh <CONFIGURE_OPTS>
make
make install
}}}

If you don't want autogen.sh to run configure, use:
{{{
NOCONFIGURE=1 ./autogen.sh
}}}


== Compiling using SCons ==
SCons is alternative build system for EKG2, meant to be simpler, more intelligent, smaller and faster. It is not accepted by most developers, but is fully supported.

To use SCons you'll have to install scons >=0.97 and python >=2.4. If anyone really needs support for older Python versions, please let us know. Older SCons version won't be supported.

{{{
scons <SCONS_OPTIONS>
scons install
}}}

To get more info, use:
{{{
scons --help
}}}
in EKG2 sources directory. Note that {{{--help}}}, unlike {{{-H}}} will list all available options.