Project name: Ronja
Project homepage: http://ronja.twibright.com
Project feedback 3-ma!l: ronja at twibright . com

This is Ronja source tree.

What can be done with the source
--------------------------------
* Compilation
* Autogenerated files cleanup
* Displaying over Apache with PHP on WWW
* Revision control 
* Hacking of course

Feedback
--------

* IRC network Freenode (server irc.freenode.net), channel #ronja
* the Ronja mailing list http://ronja.twibright.com/mlist.php

Compilation requirements
------------------------

For the project to compile (by typing "make" at the toplevel directory) you
need to have the following installed on your system. Make sure you have
installed them, one by one, in the given order:

* bash http://cnswww.cns.cwru.edu/~chet/bash/bashtop.html (works with 3.1.1(1))
* GNU Make under the "make" command (or if you have a different make and
  GNU Make is called e.g. gmake, you have to type gmake instead of make
  when compiling Ronja.) http://www.gnu.org/software/make/ works with
  3.80
* gschem version at least 1.1.0
  http://geda.seul.org/tools/gschem/index.html
  (works with 1.3.1.20080110)
* gnetlist http://geda.seul.org/tools/gnetlist/index.html
  (works with 20040111)
* gnucap http://www.gnu.org/software/gnucap/ (works with 0.35)
* gnuplot http://gnuplot.info/ (works with 4.0)
* GNU make http://www.gnu.org/software/make/ (works with 3.79.1)
* Inkscape http://inkscape.org (works with 0.45.1)
* Bitstream Vera fonts installed so they appear in inkscape font selection
  http://www.gnome.org/fonts/
* ImageMagick http://www.imagemagick.org/ (works with 6.2.8) with PNG support
  compiled in. To test whether PNG support is compiled in, try to convert
  some png image into JPEG (convert foo.png foo.jpg).
* GhostScript http://www.ghostscript.com/ (works with 7.00)
* Perl http://www.perl.org (works with 5.8.5)
* BRL-CAD http://www.brlcad.org (works with 7.2.2)
* GNU R http://www.r-project.org (works with 2.3.1)
* transcode http://www.transcoding.org/ (works with 1.0.2). Must have support
  for lame, that means if you are compiling it then you have to have the lame
  already installed, not install lame after you compile transcode.
* Xvid, http://www.xvid.org/, works with 1.1.0.
* mjpeg-tools, http://mjpeg.sourceforge.net/ . Works with 1.9.0rc3
* Libtheora's "encoder_example" installed under theora_encoder_example name within $PATH,
  works with 1.0alpha7 http://www.theora.org/ I do it by making sure libvorbis
  and libogg are installed, downloading libtherora, compiling it, installing,
  and then symlinking libtheora-1.0alpha7/examples/encoder_example into
  /usr/bin, where libtheora-1.0alpha7 is the directory with the sources.
* Twibright VNCrec http://ronja.twibright.com/utils/vncrec/
* Dirac http://dirac.sourceforge.net/ (works with 0.9.1)
* Lame http://lame.sourceforge.net/index.php (works with 3.96.1)
* flac http://flac.sourceforge.net/ (works with 1.1.2)
* SoX (http://sox.sourceforge.net/) (works with 14.0.1)
* z80-asm http://wwwhomes.uni-bielefeld.de/achim/z80-asm.html (works with 2.4pre3)
* Optional: gifsicle (will produce 4 times smaller animated GIFs).
  Works with 1.44.  http://www.lcdf.org/gifsicle/


The versions shouldn't be important (we strive for portability, at all :) ).
But if you experience problems and don't want to wait for support, you may
try those listed if they work for you.
This list is maybe still incomplete. If you get a crash dues to missing
program, exercise the support please :)

Compilation
-----------
Go to the toplevel directory (i. e. ronja/trunk/ typically, datasheets/ will be
your subdirectory). Ensure you are running under X Window System (DISPLAY
variable is set) and type "make" (or the name under GNU Make is hidden). On a
3700 bogomips machine it takes about 6 minutes.

Cleaning the source
-------------------
The same as above, but type "make clean". This will clean all autogenerated
sources

Displaying over Apache with PHP
-------------------------------

You need to have Apache with mod_php (or php) installed:
* Apache http://httpd.apache.org/ (works with 2.0.50)
* PHP http://www.php.net/ (works with 5.0.1)
Then ensure that the toplevel ronja/trunk/ directory is directly visible under
a host (no subdirectory), so that e. g. http://foo.bar.com/ points directly
to ronja/trunk/ . This should display you the Ronja poster and titlepage when
you access http://foo.bar.com then. You might need to set up VirtualHost
for this (see http://httpd.apache.org/docs-2.0/mod/core.html#virtualhost ).

Revision control
----------------
Ronja runs on Subversion http://subversion.tigris.org/