summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorHyungKyu Song <hk76.song@samsung.com>2013-02-16 00:52:26 +0900
committerHyungKyu Song <hk76.song@samsung.com>2013-02-16 00:52:26 +0900
commit7971aaeae56bd004926a9c8ad20ce9e51d3a65ff (patch)
treed444998270156668444cd7e9448998d4ca960db5 /README
parent5ec49d7969628ec586e19efdd894966519ed0733 (diff)
downloadpkg-config-7971aaeae56bd004926a9c8ad20ce9e51d3a65ff.tar.gz
pkg-config-7971aaeae56bd004926a9c8ad20ce9e51d3a65ff.tar.bz2
pkg-config-7971aaeae56bd004926a9c8ad20ce9e51d3a65ff.zip
Diffstat (limited to 'README')
-rw-r--r--README34
1 files changed, 34 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..cb3c345
--- /dev/null
+++ b/README
@@ -0,0 +1,34 @@
+pkg-config is a script to make putting together all the build
+flags when compiling/linking a lot easier.
+
+Report bugs at http://bugzilla.freedesktop.org/
+
+
+To use pkg-config, do something like the following in your configure.ac
+
+ PKG_CHECK_MODULES([GNOME], [gtk > 1.2.8 gnomeui >= 1.2.0])
+
+This puts the neccesary include flags to compile/link something against
+libgnomeui and all its dependencies in $(GNOME_CFLAGS), and the -L/-l flags
+for linking in $(GNOME_LIBS).
+
+Users can define the PKG_CONFIG environment variable to point at the
+right one, or if they cross-compile and have a correctly named pkg-config
+(eg. arm-linux-pkg-config) in their PATH that will be used in preference.
+
+Users can also define the GNOME_CFLAGS and GNOME_LIBS environment variables
+if they think they know better, pkg-config will not be called if they do
+that.
+
+The "gtk > 1.2.8" part is only neccesary if you want to specifically check
+if libgtk is version 1.2.8 or higher. Otherwise, the flags for gtk
+will be included automatically, since libgnomeui depends on gtk.
+So you could just say:
+
+ PKG_CHECK_MODULES([GNOME], [gnomeui])
+
+for any version of gnomeui.
+
+For more info, there's even a man page, try 'man pkg-config'
+
+