User:Timothee Flutre/Notebook/Postdoc/2012/11/27 - Revision history

Timothee Flutre: /* How to make a GNU package? */ add link to tuto by Martin Mann

Timothee Flutre — Wed, 10 Apr 2013 15:43:51 GMT

How to make a GNU package?: add link to tuto by Martin Mann

←Older revision		Revision as of 15:43, 10 April 2013
Line 7:		Line 7:
	<!-- ##### DO NOT edit above this line unless you know what you are doing. ##### -->		<!-- ##### DO NOT edit above this line unless you know what you are doing. ##### -->
	==How to make a GNU package?==		==How to make a GNU package?==
		+
		+	''(A very good tutorial by Martin Mann is available [http://www.bioinf.uni-freiburg.de/~mmann/HowTo/automake.html here].)''

	* find a name for the package, for instance "hello"		* find a name for the package, for instance "hello"

Timothee Flutre: /* How to make a GNU package? */

Timothee Flutre — Fri, 22 Mar 2013 15:21:31 GMT

How to make a GNU package?

←Older revision		Revision as of 15:21, 22 March 2013
Line 25:		Line 25:
	touch configure.ac Makefile.am src/Makefile.am doc/Makefile.am # and edit these files		touch configure.ac Makefile.am src/Makefile.am doc/Makefile.am # and edit these files
	autoreconf --install # use autoreconf --force the next times you want re-build configure		autoreconf --install # use autoreconf --force the next times you want re-build configure
-	./configure # can be followed by --prefix=~~~/bin~~, LDFLAGS=-L/usr/local/lib, etc	+	./configure # can be followed by --prefix=$HOME, LDFLAGS=-L/usr/local/lib, etc
	make # can be followed by LDFLAGS="-L/usr/local/lib -static"		make # can be followed by LDFLAGS="-L/usr/local/lib -static"
	make check # to automatically execute the tests		make check # to automatically execute the tests

Timothee Flutre: /* How to make a GNU package? */ add tip for how to use -static

Timothee Flutre — Sun, 27 Jan 2013 23:27:37 GMT

How to make a GNU package?: add tip for how to use -static

←Older revision		Revision as of 23:27, 27 January 2013
Line 13:		Line 13:
	mkdir mypkg; cd mypkg		mkdir mypkg; cd mypkg
	touch COPYING README INSTALL NEWS AUTHORS ChangeLog		touch COPYING README INSTALL NEWS AUTHORS ChangeLog
-	mkdir src build-aux doc tests # you can also add other directories, e.g. ~~lib~~ scripts	+	mkdir src build-aux doc tests # you can also add other directories, e.g. scripts, data, lib

	* populate the <code>src/</code> directory with your code, e.g. <code>hello.cpp</code>		* populate the <code>src/</code> directory with your code, e.g. <code>hello.cpp</code>
Line 26:		Line 26:
	autoreconf --install # use autoreconf --force the next times you want re-build configure		autoreconf --install # use autoreconf --force the next times you want re-build configure
	./configure # can be followed by --prefix=~/bin, LDFLAGS=-L/usr/local/lib, etc		./configure # can be followed by --prefix=~/bin, LDFLAGS=-L/usr/local/lib, etc
-	make	+	make # can be followed by LDFLAGS="-L/usr/local/lib -static"
	make check # to automatically execute the tests		make check # to automatically execute the tests

Timothee Flutre: /* How to make a GNU package? */ test git repo with git clone

Timothee Flutre — Tue, 15 Jan 2013 17:14:03 GMT

How to make a GNU package?: test git repo with git clone

←Older revision		Revision as of 17:14, 15 January 2013
Line 34:		Line 34:
	wget -O fdl.texi http://cvs.savannah.gnu.org/viewvc/checkout/gnustandards/fdl.texi?root=gnustand		wget -O fdl.texi http://cvs.savannah.gnu.org/viewvc/checkout/gnustandards/fdl.texi?root=gnustand
	ards&content-type=text%2Fplain		ards&content-type=text%2Fplain
-	touch ~~manual_hellp~~.texi # and edit	+	touch manual_hello.texi # and edit
	make pdf		make pdf
	</nowiki>		</nowiki>
Line 43:		Line 43:
	tar tzvf mypkg-0.1.tar.gz # to check what is in the release		tar tzvf mypkg-0.1.tar.gz # to check what is in the release

-	* ~~share~~ your code, for instance on [http://en.wikipedia.org/wiki/~~GitHub GitHub~~] (~~see~~ [http://~~openwetware~~.~~org~~/~~wiki/User:Timothee_Flutre/Notebook/Postdoc/2012/08/14 my tips~~])	+	* version your code, for instance with [http://en.wikipedia.org/wiki/Git_%28software%29 Git] (read the [http://git-scm.com/book book]!):
	git init		git init
	git add AUTHORS COPYING ChangeLog INSTALL Makefile.am NEWS README TODO build-aux/* configure.ac		git add AUTHORS COPYING ChangeLog INSTALL Makefile.am NEWS README TODO build-aux/* configure.ac
-	git add src/Makefile.am ~~# etc~~	+	git add src/Makefile.am src/hello.cpp
-	git add doc/~~fdl~~.texi doc/~~Makefile~~.~~am # etc~~	+	git add doc/Makefile.am doc/manual_hello.texi doc/fdl.texi
-	git add tests/Makefile.am ~~# etc~~	+	git add tests/Makefile.am tests/test1.bash
	git commit -m "first commit"		git commit -m "first commit"
		+	# and edit .git/info/exclude or .gitignore, tag your release, etc
		+
		+	And check that you have all required files in your repo:
		+	cd ~/tmp; git clone ~/<path_to_original_repo>/hello
		+	autoreconf --force
		+	./configure
		+	make
		+	make check
		+	make install
		+	make distcheck
		+
		+	* share your code, for instance on [http://en.wikipedia.org/wiki/GitHub GitHub] (read the [http://help.github.com/ help]!)

	<!-- ##### DO NOT edit below this line unless you know what you are doing. ##### -->		<!-- ##### DO NOT edit below this line unless you know what you are doing. ##### -->

Timothee Flutre: /* How to make a GNU package? */ add git cmd-line

Timothee Flutre — Tue, 15 Jan 2013 16:50:40 GMT

How to make a GNU package?: add git cmd-line

←Older revision		Revision as of 16:50, 15 January 2013
Line 8:		Line 8:
	==How to make a GNU package?==		==How to make a GNU package?==

-	* find a name for the package, for instance "~~mypkg~~"	+	* find a name for the package, for instance "hello"

	* structure the package directory:		* structure the package directory:
	mkdir mypkg; cd mypkg		mkdir mypkg; cd mypkg
	touch COPYING README INSTALL NEWS AUTHORS ChangeLog		touch COPYING README INSTALL NEWS AUTHORS ChangeLog
-	mkdir src build-aux doc tests #lib scripts	+	mkdir src build-aux doc tests # you can also add other directories, e.g. lib scripts

	* populate the <code>src/</code> directory with your code, e.g. <code>hello.cpp</code>		* populate the <code>src/</code> directory with your code, e.g. <code>hello.cpp</code>
Line 23:		Line 23:

	* use [http://en.wikipedia.org/wiki/GNU_build_system Autotools] (see the [http://www.gnu.org/software/automake/manual/automake.html manual] and this [http://www.lrde.epita.fr/~adl/autotools.html tutorial]; for the tests, have a look [http://www.sourceware.org/autobook/autobook/autobook_98.html here]):		* use [http://en.wikipedia.org/wiki/GNU_build_system Autotools] (see the [http://www.gnu.org/software/automake/manual/automake.html manual] and this [http://www.lrde.epita.fr/~adl/autotools.html tutorial]; for the tests, have a look [http://www.sourceware.org/autobook/autobook/autobook_98.html here]):
-	touch configure.ac Makefile.am src/Makefile.am doc/Makefile.am #and edit	+	touch configure.ac Makefile.am src/Makefile.am doc/Makefile.am # and edit these files
-	autoreconf --install # use autoreconf --force the next times	+	autoreconf --install # use autoreconf --force the next times you want re-build configure
-	./configure #can be followed by --prefix=~/bin, LDFLAGS=-L/usr/local/lib, etc	+	./configure # can be followed by --prefix=~/bin, LDFLAGS=-L/usr/local/lib, etc
	make		make
-	make check	+	make check # to automatically execute the tests

	* write some documentation in [http://en.wikipedia.org/wiki/Texinfo Texinfo]:		* write some documentation in [http://en.wikipedia.org/wiki/Texinfo Texinfo]:
Line 34:		Line 34:
	wget -O fdl.texi http://cvs.savannah.gnu.org/viewvc/checkout/gnustandards/fdl.texi?root=gnustand		wget -O fdl.texi http://cvs.savannah.gnu.org/viewvc/checkout/gnustandards/fdl.texi?root=gnustand
	ards&content-type=text%2Fplain		ards&content-type=text%2Fplain
-	touch ~~manual~~.texi #and edit	+	touch manual_hellp.texi # and edit
	make pdf		make pdf
	</nowiki>		</nowiki>
Line 40:		Line 40:
	* make your package available to anyone:		* make your package available to anyone:
	make install		make install
-	make distcheck #can be followed by DISTCHECK_CONFIGURE_FLAGS=LDFLAGS=-L/usr/local/lib for instance	+	make distcheck # can be followed by DISTCHECK_CONFIGURE_FLAGS=LDFLAGS=-L/usr/local/lib for instance
-	tar tzvf mypkg-0.1.tar.gz #to check what is in the release	+	tar tzvf mypkg-0.1.tar.gz # to check what is in the release

	* share your code, for instance on [http://en.wikipedia.org/wiki/GitHub GitHub] (see [http://openwetware.org/wiki/User:Timothee_Flutre/Notebook/Postdoc/2012/08/14 my tips])		* share your code, for instance on [http://en.wikipedia.org/wiki/GitHub GitHub] (see [http://openwetware.org/wiki/User:Timothee_Flutre/Notebook/Postdoc/2012/08/14 my tips])
		+	git init
		+	git add AUTHORS COPYING ChangeLog INSTALL Makefile.am NEWS README TODO build-aux/* configure.ac
		+	git add src/Makefile.am # etc
		+	git add doc/fdl.texi doc/Makefile.am # etc
		+	git add tests/Makefile.am # etc
		+	git commit -m "first commit"

	<!-- ##### DO NOT edit below this line unless you know what you are doing. ##### -->		<!-- ##### DO NOT edit below this line unless you know what you are doing. ##### -->

Timothee Flutre: /* How to make a GNU package? */ mention autoreconf --force

Timothee Flutre — Wed, 09 Jan 2013 00:44:51 GMT

How to make a GNU package?: mention autoreconf --force

←Older revision		Revision as of 00:44, 9 January 2013
Line 24:		Line 24:
	* use [http://en.wikipedia.org/wiki/GNU_build_system Autotools] (see the [http://www.gnu.org/software/automake/manual/automake.html manual] and this [http://www.lrde.epita.fr/~adl/autotools.html tutorial]; for the tests, have a look [http://www.sourceware.org/autobook/autobook/autobook_98.html here]):		* use [http://en.wikipedia.org/wiki/GNU_build_system Autotools] (see the [http://www.gnu.org/software/automake/manual/automake.html manual] and this [http://www.lrde.epita.fr/~adl/autotools.html tutorial]; for the tests, have a look [http://www.sourceware.org/autobook/autobook/autobook_98.html here]):
	touch configure.ac Makefile.am src/Makefile.am doc/Makefile.am #and edit		touch configure.ac Makefile.am src/Makefile.am doc/Makefile.am #and edit
-	autoreconf --install	+	autoreconf --install # use autoreconf --force the next times
	./configure #can be followed by --prefix=~/bin, LDFLAGS=-L/usr/local/lib, etc		./configure #can be followed by --prefix=~/bin, LDFLAGS=-L/usr/local/lib, etc
	make		make

Timothee Flutre: /* How to make a GNU package? */ add link to manual

Timothee Flutre — Tue, 08 Jan 2013 18:05:47 GMT

How to make a GNU package?: add link to manual

←Older revision		Revision as of 18:05, 8 January 2013
Line 22:		Line 22:
	* fill the information files, such as README ([http://bzr.savannah.gnu.org/lh/gsl/trunk/annotate/head:/README example]), INSTALL ([http://bzr.savannah.gnu.org/lh/gsl/trunk/annotate/head:/INSTALL example])...		* fill the information files, such as README ([http://bzr.savannah.gnu.org/lh/gsl/trunk/annotate/head:/README example]), INSTALL ([http://bzr.savannah.gnu.org/lh/gsl/trunk/annotate/head:/INSTALL example])...

-	* use [http://en.wikipedia.org/wiki/GNU_build_system Autotools] (see [http://www.lrde.epita.fr/~adl/autotools.html tutorial]; for the tests, have a look [http://www.sourceware.org/autobook/autobook/autobook_98.html here]):	+	* use [http://en.wikipedia.org/wiki/GNU_build_system Autotools] (see the [http://www.gnu.org/software/automake/manual/automake.html manual] and this [http://www.lrde.epita.fr/~adl/autotools.html tutorial]; for the tests, have a look [http://www.sourceware.org/autobook/autobook/autobook_98.html here]):
	touch configure.ac Makefile.am src/Makefile.am doc/Makefile.am #and edit		touch configure.ac Makefile.am src/Makefile.am doc/Makefile.am #and edit
	autoreconf --install		autoreconf --install

Timothee Flutre: /* How to make a GNU package? */ add info for tests

Timothee Flutre — Wed, 19 Dec 2012 23:01:24 GMT

How to make a GNU package?: add info for tests

←Older revision		Revision as of 23:01, 19 December 2012
Line 13:		Line 13:
	mkdir mypkg; cd mypkg		mkdir mypkg; cd mypkg
	touch COPYING README INSTALL NEWS AUTHORS ChangeLog		touch COPYING README INSTALL NEWS AUTHORS ChangeLog
-	mkdir src build-aux doc ~~test~~ #lib scripts	+	mkdir src build-aux doc tests #lib scripts

	* populate the <code>src/</code> directory with your code, e.g. <code>hello.cpp</code>		* populate the <code>src/</code> directory with your code, e.g. <code>hello.cpp</code>
Line 22:		Line 22:
	* fill the information files, such as README ([http://bzr.savannah.gnu.org/lh/gsl/trunk/annotate/head:/README example]), INSTALL ([http://bzr.savannah.gnu.org/lh/gsl/trunk/annotate/head:/INSTALL example])...		* fill the information files, such as README ([http://bzr.savannah.gnu.org/lh/gsl/trunk/annotate/head:/README example]), INSTALL ([http://bzr.savannah.gnu.org/lh/gsl/trunk/annotate/head:/INSTALL example])...

-	* use [http://en.wikipedia.org/wiki/GNU_build_system Autotools] (see [http://www.lrde.epita.fr/~adl/autotools.html tutorial]):	+	* use [http://en.wikipedia.org/wiki/GNU_build_system Autotools] (see [http://www.lrde.epita.fr/~adl/autotools.html tutorial]; for the tests, have a look [http://www.sourceware.org/autobook/autobook/autobook_98.html here]):
	touch configure.ac Makefile.am src/Makefile.am doc/Makefile.am #and edit		touch configure.ac Makefile.am src/Makefile.am doc/Makefile.am #and edit
	autoreconf --install		autoreconf --install

Timothee Flutre: /* How to make a GNU package? */ add examples for README and INSTALL

Timothee Flutre — Wed, 28 Nov 2012 06:17:32 GMT

How to make a GNU package?: add examples for README and INSTALL

←Older revision		Revision as of 06:17, 28 November 2012
Line 20:		Line 20:
	wget -O COPYING http://www.gnu.org/licenses/gpl-3.0.txt		wget -O COPYING http://www.gnu.org/licenses/gpl-3.0.txt

-	* fill the information files, such as README, INSTALL...	+	* fill the information files, such as README ([http://bzr.savannah.gnu.org/lh/gsl/trunk/annotate/head:/README example]), INSTALL ([http://bzr.savannah.gnu.org/lh/gsl/trunk/annotate/head:/INSTALL example])...

	* use [http://en.wikipedia.org/wiki/GNU_build_system Autotools] (see [http://www.lrde.epita.fr/~adl/autotools.html tutorial]):		* use [http://en.wikipedia.org/wiki/GNU_build_system Autotools] (see [http://www.lrde.epita.fr/~adl/autotools.html tutorial]):

Timothee Flutre: /* How to make a GNU package? */ distcheck + license + misc

Timothee Flutre — Wed, 28 Nov 2012 05:54:16 GMT

How to make a GNU package?: distcheck + license + misc

←Older revision		Revision as of 05:54, 28 November 2012
Line 8:		Line 8:
	==How to make a GNU package?==		==How to make a GNU package?==

-	* find a name for the package	+	* find a name for the package, for instance "mypkg"

	* structure the package directory:		* structure the package directory:
-	touch README INSTALL NEWS AUTHORS ~~COPYING~~ ChangeLog	+	mkdir mypkg; cd mypkg
-	mkdir src build-aux doc test #lib	+	touch COPYING README INSTALL NEWS AUTHORS ChangeLog
		+	mkdir src build-aux doc test #lib scripts

	* populate the <code>src/</code> directory with your code, e.g. <code>hello.cpp</code>		* populate the <code>src/</code> directory with your code, e.g. <code>hello.cpp</code>
		+
		+	* retrieve the license, for instance [http://www.gnu.org/licenses/gpl.html GPLv3]:
		+	wget -O COPYING http://www.gnu.org/licenses/gpl-3.0.txt
		+
		+	* fill the information files, such as README, INSTALL...

	* use [http://en.wikipedia.org/wiki/GNU_build_system Autotools] (see [http://www.lrde.epita.fr/~adl/autotools.html tutorial]):		* use [http://en.wikipedia.org/wiki/GNU_build_system Autotools] (see [http://www.lrde.epita.fr/~adl/autotools.html tutorial]):
	touch configure.ac Makefile.am src/Makefile.am doc/Makefile.am #and edit		touch configure.ac Makefile.am src/Makefile.am doc/Makefile.am #and edit
	autoreconf --install		autoreconf --install
-	./configure #can be followed by --prefix=~~... or~~ LDFLAGS=~~...~~	+	./configure #can be followed by --prefix=~/bin, LDFLAGS=-L/usr/local/lib, etc
	make		make
	make check		make check
Line 29:		Line 35:
	ards&content-type=text%2Fplain		ards&content-type=text%2Fplain
	touch manual.texi #and edit		touch manual.texi #and edit
		+	make pdf
	</nowiki>		</nowiki>

	* make your package available to anyone:		* make your package available to anyone:
	make install		make install
-	make ~~distclean~~	+	make distcheck #can be followed by DISTCHECK_CONFIGURE_FLAGS=LDFLAGS=-L/usr/local/lib for instance
-	~~make dist~~	+	tar tzvf mypkg-0.1.tar.gz #to check what is in the release

	* share your code, for instance on [http://en.wikipedia.org/wiki/GitHub GitHub] (see [http://openwetware.org/wiki/User:Timothee_Flutre/Notebook/Postdoc/2012/08/14 my tips])		* share your code, for instance on [http://en.wikipedia.org/wiki/GitHub GitHub] (see [http://openwetware.org/wiki/User:Timothee_Flutre/Notebook/Postdoc/2012/08/14 my tips])