autodocified
[libfirm] / README
1
2 This is a library implementing the intermediate representation
3 FIRM developed at IPD Goos, Uni Karlsruhe.
4
5 Create an architecture dependent directory (eg 'mkdir i686-linux') an cd
6 to it. Call ../configure with wanted features (see ../configure --help
7 for more hints). Call 'make depend; make' to construct the library. This
8 creates a file libfirm.a
9
10 To test the library goto ./testprograms and make and run the
11 test examples placed there:
12
13 make depend; make
14 cd testprograms
15 make
16 make run
17
18 If you have set up the include and libdir using configure you can install
19 the library and its headers by 'make install'.  This is encouraged if the
20 library is hooked up to any other modules, e.g., a front end.  Only the
21 external headers are guaranteed to remain stable, the implementation might
22 change.
23
24 For more documentation see /include/firm.h.
25 To generate FIRM code from a compiler frontend read the documentation
26 in ./include/ircons.h.
27 About Firm you can learn in UKA tech-report 1999-44.