X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=README;h=b8a83f450f2a2cab549f9ef821f5647b14e1ee85;hb=25a9079a440dca3115aedcc4c22438e187ed9d7d;hp=1df644864458594e45e1e687635f9aa7328f342f;hpb=34c0682b53b3cac893e8f58a36dd5886a6831e1c;p=libfirm diff --git a/README b/README index 1df644864..b8a83f450 100644 --- a/README +++ b/README @@ -1,27 +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. -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 +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 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. -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-14. +"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.