f-cpu/COMPILE.txt
created Tue Aug 28 08:26:04 2001 by whygee@f-cpu.org
version sam mar 30 07:34:59 2002

Thanks for reading this file which explains how compile the
different parts of this source tree. If you have a "source only"
version of the F-CPU package, you will remark that some steps are
required to obtain a working source tree. You can probably find
already pre-processed source files but their modification will
require the modification of the original (before preprocessing)
files.

A shell (bash) script called install.sh should help you
setup the files, run some sanity checks and perform some
basic compilations. It is currently only in its preliminary
form but here is what to do if you want/have to do it by hand.

Basically, you need a Linux/POSIX environment with the following GNU tools :
 - a good shell (bash is cool)
 - m4 (we can't configure anything without this)
 - a text editor of your choice (sorry, no time to start loosy flamewars :-D)
 - make (for the Makefile's)
 - gcc (for the C utilities)
and a VHDL tool (see the VHDL-HOWTO in the f-cpu/vhdl directory
for more explanations). Notice that the F-CPU manual is not addressed here.

There is no global environment variable (at least yet).
Something like "$FCPU_DIR" would be useful but could make
working simultaneously with several versions difficult.
We work with relative directory paths, assuming "f-cpu/"
as a base directory in our examples. Usually, this directory
is created when the tarball is extracted.

First, you have to go to f-cpu/configuration/ and run "make" :
this command will create/update a lot of files which depend
on user settings in different langages. This operation was first
performed by a script (f-cpu/configure.sh) but it is now only a
wrapper for the make utility. However this name was chosen on purpose
because "configure" is usually executed before "make" in most GNU packages.

Only after this step is performed, you can start to look around.
Please look at the f-cpu/configuration directory for more information
about the configuration stage. It is also where the "original" files
(suffixed with ".in") are stored.

Then, you can start to compile the tools and the VHDL packages.
A shell script (suffixed with ".bat" for DOS or ".sh" for un*x)
or a Makefile is provided in each subdirectory. Concerning the
VHDL sides, read the HOWTO.

Have fun,
YG
