Getting Amaya from CVS or Github repository

---

Requirements

Disk space

Just checking out requires 8 M for libwww and 38M for Amaya. Building will easily double the size, so it's better to have 100M available.

cvs (version 1.10 or later) or git (version 1.7 or later)

Perl

No need to introduce this fun, lego-like, and poetic scripting language

On Unix platforms you MUST have the following GNU tools installed in order to continue. Check that you have the following programs with the correct version number:

gcc and GNU make

Automake relies on features provided by gcc and GNU make that don't come with other compilers and makes. When compiling directly from CVS you MUST use these gcc and gmake.

GNU automake (version 1.4 or later)

Automake is a tool for automatically generating Makefile.in's which are used by autoconf

GNU autoconf (version 2.13 or later, but avoid version 2.14)

A tool for automatically generating Makefile's which are used by make

GNU libtool (version 1.2d or later)

A tool for automatically handling generation of shared libraries. If you upgrade libtool to a new version then you MUST rerun the configure script as some files used by libtool have to be regenerated.

Other stuff

X11 , GTK/GDK 1.2 development headers and libraries

Redland 0.9.16 or more recent. Read below to see how to get it bootsrapped.

Getting sources from Github

In order to work with Github, you need to create a github account.

To get the Amaya sources form Github, you have to 'clone' the Amaya project. On your local machine, run the following code:

% git clone https://github.com/w3c/Amaya-Editor.git

The Github Amaya repository is only available in read-only mode, if you want to work on the code, you'll have to fork the project and work on the forked repository.

To fork the project, go to the Amaya repository and click the "Fork" button.

Getting sources from CVS

The following requires that you are familiar with CVS - if not then look at Cyclic's pages on CVS.

Anonymous checkout is read-only access which allows you to get the latest edits and to provide patches to be integrated into the code base. The instructions should work for both Unix and Windows

.

Start by login as follows:

% cvs -d :pserver:[email protected]:/sources/public login

after which you type "anonymous" as password.

To get the latest version from the CVS repository, run this command at the same selected position:

% cvs -d :pserver:[email protected]:/sources/public -z3 checkout Amaya

Once you have checked out the amaya tree (not a specific revision), you can get any updates committed to the tree by using the cvs update command like this

% 
% cd Amaya
% cvs -z3 update -dP

It is important that you use the "-dP" flag so that you get new directories as well as updated files. Now you MUST repeat the compilation bootstrapping procedure.

Getting libwww

By default it's recommanded to download these libraries from the Amaya web site: download the amaya-lib-src-V.R.tgz file. In that case you can skip to the next section.

You also can use the libww CVS repository instead of the version provided by the distribution package (amaya-lib-src). For that, run this command at the same selected position:

% cvs -d :pserver:[email protected]:/sources/public -z3 checkout -rAmaya libwww

When using the libwww CVS repository there are a few steps you have to go through which are already done if using the distribution package. Follow these three steps:

1. Generate include files
2. Unix only: generate make files
3. Configure and compile libwww

1. Generate Include Files (Windows)

On both Windows and Unix you can generate the *.h files and the *.def files by running a Perl script provided by Eric Prud'hommeaux. Never mind that it gives a few warnings when it runs - they are all OK. It requires that you have a recent version of Perl on your machine. Run the script like this (note the explicit use of the perl interpreter):

% cd libwww
% perl config/winConfigure.pl

Windows people are now done and can jump directly to the instructions for how to compile Amaya. On Unix, you need two additional steps.

2. Generate the Make and Include file (Unix only)

Now generate the make and include files as follows - don't worry about the warnings produced by autoconf (If libtoolize advises you to copy some files, do as it says):

% cd libwww
% libtoolize -c -f
% perl config/winConfigure.pl
% aclocal; autoheader; automake; autoconf

Now you MUST run the configure script as described in the next section on Configuring and Compiling Amaya instructions. If for some reason you have trouble running the configure script then try and run this command instead

% make distclean; aclocal; autoheader; automake;
autoconf

Getting other libraries

To be able to compile Amaya, you will need redland, wxWidgets, Mesa and libwww subtrees. You can get these extra subtrees by downloading and installing at the selected position the last Amaya sources tarball (amaya-lib-src-11.4.4.tgz file).

Configuring and Compiling Amaya

Remember to subscribe to the <[email protected]> mailing list (archives) for information of new features as well as discussions of problems and ideas.

Congratulations - you are now ready to configure and compile Amaya:

• on Linux and Mac OS platforms, read the Unix compiling section.
• on Windows platforms, read the Windows compiling section.