===============================================================================
This is a Gentoo overlay with ebuilds for the Democratic Experience server and
client, and their various dependencies that are not in Portage yet.
Check http://www.demexp.org if you arrived here by mistake and are curious what
this is all about.


===============================================================================
Installation:  To use this overlay, try the following procedure...

- Get familiar with usage of ebuilds overlay if you're not yet. `man make.conf`
is worth reading in particular.

- Download the latest demexp-overlay-TIMESTAMP.tar.bz2 from this address:
    http://tdegreni.free.fr/demexp/

- Unpack it where ever you want (I like "/var/portage/overlays"). It will 
create a "demexp" directory. If you're updating from a previous demexp overlay,
delete the old one before, to be sure what you get at the end is clean.

- Add the absolute path to this directory to your PORTAGE_OVERLAY variable in
"/etc/make.conf". In my example, it would be "/var/portage/overlays/demexp". 
Remember that you can have as many overlay as you wish here, so there is
really no need to mix that one with others like the "/usr/local/portage" you 
may already be using. Keeping it separate will make future updates easier.

- Ebuilds in this overlay are all marked ~x86 only. If you are using an other
architecture, you will have to edit the ebuilds and add whatever keywords you
need. And if you are running stable x86, you will have to use package.keywords
to declare you accept this ebuilds (read `man portage` for details on using
/etc/portage/packages.* files).

- The first package you should (re)install is the ocaml compiler itself. It 
happens that the official ebuild doesn't install some files that are needed
by some of the other packages from this overlay (CDuce, namely):
    # emerge --oneshot =dev-lang/ocaml-3.08.3-r1

- Then you should be able to install the DemExp client.
    # emerge demexp-gtk2-client
  ...or the server:
    # emerge demexp-server
Both ebuilds will give you short hints for getting started, so watch your
console :)

- If you're interrested in DemExp internals, you can install app-doc/demexp-book
(or enable the "doc" USE flag on the client or server, in which case it will get
installed to).


===============================================================================
Troubleshooting:

- If you need help with installation of this ebuilds, don't hesitate to send 
contact me: Thomas de Grenier de Latour (TGL) <degrenier@easyconnect.fr>

- For issues concerning the softwares themselves, come on the demexp-dev 
mailing-list: http://lists.nongnu.org/mailman/listinfo/demexp-dev

- To report backtrace in case of program failure, you will have to recompile
the software (demexp-server or demexp-gtk2-client) with the "debug" flag:
  # USE="debug" emerge demexp-server
or:
  # USE="debug" emerge demexp-gtk2-client
You will then get some bytecode version of the software, "demexp-server.bc"
or "demexp-gtk2-client.bc". This versions can produce backtraces that you
can report to developers. If the failure is in with the server, you will
have to run it manually instead of using the init script:
  # /usr/sbin/demexp-server.bc --bases /var/lib/demexp/bases.dmxp


===============================================================================
Changelog:

 * 20050709: Update to 0.5.4. Also added the "debug" USE flag to demexp-server
   and demexp-gtk2-client, to enable autotests and compilation of the bytecode
   versions of the softwares.

 * 20050707: Minor cleanups
    - added RDEPEND="${DEPEND}" where is was lacking
    - dev-ml/gz: depend on >=ocaml-3.08.3-r1 because of the ld.conf issue

 * 20050706: Minor cleanups
    - reintroduced the RDEPEND from demexp-server to cduce. Yeah, it sucks, but
      there is currently no other way to make it have complete runtime deps.
      Portage defintly lacks a feature here :/
    - changed make targets in demexp-gtk2-client and demexp-server to avoid
      unnecessary compilation of the static and bytecode versions.

 * 20050705: Update to 0.5.3
    - demexp-server, demexp-gtk2-client, demexp-book: now use the new configure
      script, minor dep cleanups, etc.
    - demexp-server: init script now uses the new --logfile/--daemon options,
      and the saved pid file.
    - dev-lang/ocaml-3.08.3-r1: added fix for missing directory in ld.conf.

 * 20050702: Update to 0.5.2 (aka 0.6_pre2)
    - net-misc/demexp-gtk2-client-0.5.2 (was: demexp-client-gtk2): yup, new 
      name for this one, since that's how upstream calls it. Other changes are
      a bunch of minor stuffs: no more patch needed to add curl and expat to 
      the linking, more complete runtime deps, a desktop entry, etc.
      Also added a "gnome" USE flag which triggers installation of a GConf 
      schema for "demexp://" URI handling... Obviously completly useless, but i
      was curious about how it was working, and happy to find it out :)
    - net-misc/demexp-server-0.5.2: bump, with more complete dependencies, some
      minor improvements to the init script (it should now fill demexp.log, and
      has a debug option), less hacks needed to make it compile, and a new USE
      flag, "logrotate", to install a logrotate.d file.
    - app-doc/demexp-book-0.5.2: new package for the PDF detailed documation.
      Client and server depend on it in case the "doc" USE flag is set. In
      previous versions, there were 2 separate books, but it's now all-in-one,
      and i didn't know where to put it... hence the new package.
    - dev-ml/gz-0.5.6: new package required by both the server and the client.
      It's a wrapper module for libz and libbz2.

 * 20050328: Removed dev-ml/rpc and dev-ml/netclient from the overlay, since 
   they are now in the Portage tree. Many thanks to Matthieu Sozeau for having
   accepted this ebuilds. Hopefully dev-ml/ocaml-expat will follow, and also 
   the small additions to dev-lang/ocaml, meaning that only CDuce and DemExp
   will have to be released out of the official tree.

 * 20050325: 
    - Bumped dev-lang/cduce to 0.3.2, which fixes the 0.3.1 small typo.
    - Bumped dev-lang/ocaml to 3.08.3-r1 (simplified the way headers are 
      installed).
    - Modified dev-ml/ocaml-expat-0.9.1.ebuild to take follow ocaml-3.08.3-r1
      changes.

 * 20050321-2: Bumped dev-lang/cduce to 0.3.1, which fixes the various issues
   i've seen so far. No more patch needed, but a small typo fix in the 
   configure.ml script ('s:pxp-iso88591:pxp-lex-iso88591:').

 * 20050321: Fixed dev-lang/cduce-0.3.0 to make it compile when PXP is not 
   installed (using Expat), and removed some useless patches.

 * 20050320: Initial release. 
    - dev-ml/rpc-0.4.1
    - dev-ml/netclient-0.90.4
    - dev-ml/ocaml-expat-0.9.1 (optionnal, for cduce with USE flag "expat")
    - dev-lang/cduce-0.3.0
    - dev-lang/ocaml-3.08.3 (same as the official, but also adds compiler libs
      and headers to the installed files set)
    - net-misc/demexp-server-0.{4,5}
    - net-misc/demexp-client-gtk2-0.{4,5}