X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=README;h=b8a83f450f2a2cab549f9ef821f5647b14e1ee85;hb=a973f767f5995ec8ac72d662fb982dfb8594bf5c;hp=1fadbc053f9dc6978ddee7da10f8d0d4ffe83a54;hpb=3d16844cfe86402baf7e82c87facf630ee336b73;p=libfirm diff --git a/README b/README index 1fadbc053..b8a83f450 100644 --- a/README +++ b/README @@ -1,19 +1,21 @@ -This is a library implementing the intermediate representation -FIRM developed at IPD Goos, Uni Karlsruhe. +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' 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: +To test the library goto .//testprograms and call 'make test' +there. -make lib -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. -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-??. +"libFIRM: A Library for Compiler Optimization Reaserch Implementing +Firm", UKA tech-report 2002-5. About Firm you can learn in UKA +tech-report 1999-14.