[ghex] Add HACKING file describing how to build and run ghex from git



commit 3eb7121e7d9cec32bb1a7c4d82b54821d5672b1c
Author: Martin Olsson <martin minimum se>
Date:   Sat Mar 24 21:50:35 2012 +0100

    Add HACKING file describing how to build and run ghex from git

 HACKING     |   35 +++++++++++++++++++++++++++++++++++
 Makefile.am |    3 ++-
 2 files changed, 37 insertions(+), 1 deletions(-)
---
diff --git a/HACKING b/HACKING
new file mode 100644
index 0000000..e1adc41
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,35 @@
+HOW TO BUILD FROM GIT
+
+	First install the build dependencies (i.e. libraries that ghex uses).
+	If you're on Debian or Ubuntu you can install the build dependencies
+	of the distro packaged version of ghex using the command:
+
+		sudo apt-get build-dep ghex
+
+	If you're on Fedora, the equivalent command is:
+
+		sudo yum-builddep ghex
+
+	Other distributions have similar commands for their package managers.
+	Of course, there is no guarantee that the build dependencies of the
+	distro packaged version is the same as the git version, but in practice
+	the former gets you quite far and if not, autogen.sh will tell you
+	what is missing during the next step.
+
+	To configure and build the git version of ghex, run:
+
+		git clone git://git.gnome.org/ghex
+		cd ghex
+		./autogen.sh --prefix=~/ghex
+		make
+		make install
+
+
+	After you have done this you can run and test the built ghex binary using:
+
+		GSETTINGS_SCHEMA_DIR=~/ghex/share/glib-2.0/schemas src/ghex
+
+
+	For instructions on how to prepare a patch, see:
+
+		https://live.gnome.org/Git/Developers#Contributing_patches
diff --git a/Makefile.am b/Makefile.am
index 3cf1ae2..9edcfdb 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -8,6 +8,7 @@ SUBDIRS = data po help src icons
 
 EXTRA_DIST =			\
 	gnome-doc-utils.make	\
-	COPYING-DOCS
+	COPYING-DOCS		\
+	HACKING
 
 -include $(top_srcdir)/git.mk



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]