X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=README;h=640ffe5a14751f9111555db9b16c3134da61acf3;hb=e569ea0a211514dcb0d96207d2600dd0fb18e23b;hp=1fadbc053f9dc6978ddee7da10f8d0d4ffe83a54;hpb=3d16844cfe86402baf7e82c87facf630ee336b73;p=libfirm diff --git a/README b/README index 1fadbc053..640ffe5a1 100644 --- a/README +++ b/README @@ -2,18 +2,26 @@ This is a library implementing the intermediate representation FIRM developed at IPD Goos, Uni Karlsruhe. -Call make lib to construct the library. This creates a file -libfirm.a and extracts all necessary header files to ./include. +Create an architecture dependent directory (eg 'mkdir i686-linux') an cd +to it. Call ../configure with wanted features (see ../configure --help +for more hints). Call 'make depend; make' to construct the library. This +creates a file libfirm.a To test the library goto ./testprograms and make and run the test examples placed there: -make lib +make depend; make cd testprograms make make run +If you have set up the include and libdir using configure you can install +the library and its headers by 'make install'. This is encouraged if the +library is hooked up to any other modules, e.g., a front end. Only the +external headers are guaranteed to remain stable, the implementation might +change. + For more documentation see /include/firm.h. To generate FIRM code from a compiler frontend read the documentation in ./include/ircons.h. -About Firm you can learn in UKA tech-report 1999-??. +About Firm you can learn in UKA tech-report 1999-44.