diff --git a/README.md b/README.md new file mode 100644 index 0000000..536e371 --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +DeforaOS libDesktop +=================== + +About libDesktop +---------------- + +libDesktop is a collection of compatibility and portability routines to help +with the development of desktop applications using the Gtk+ toolkit. + + +Compiling libDesktop +-------------------- + +With GCC, this should be enough: + + $ make + +To install libDesktop in a dedicated directory, like `/path/to/libDesktop`: + + $ make PREFIX="/path/to/libDesktop" install + + +Using Gtk+ version 3 +-------------------- + +libDesktop defaults to the version 2 of the Gtk+ toolkit. Alternatively, it is +possible to re-generate the Makefiles for the Gtk+ 3 toolkit with `configure(1)` +from the DeforaOS configure project, found at +. The procedure is then as +follows: + + $ $EDITOR data/libDesktop.pc.in + [replace "gtk+-2.0" with "gtk+-3.0"] + $ $EDITOR src/project.conf tests/project.conf tools/project.conf + [comment lines in and out as described] + $ make distclean + $ configure + $ make + +Please refer to the documentation of DeforaOS configure for further +instructions. diff --git a/project.conf b/project.conf index 050b702..43ee98e 100644 --- a/project.conf +++ b/project.conf @@ -3,4 +3,4 @@ version=0.3.0 config=h,sh subdirs=data,doc,include,src,tests,tools -dist=Makefile,COPYING,config.h,config.sh +dist=Makefile,COPYING,README.md,config.h,config.sh