Skip to content

Commit

Permalink
Adapt the build instructions to the git repo
Browse files Browse the repository at this point in the history
i.e. you'll have to fetch from git instead of svn now and when building
a release you'll have to tag via git.
  • Loading branch information
egli committed May 20, 2014
1 parent 983d523 commit 71647d6
Showing 1 changed file with 31 additions and 35 deletions.
66 changes: 31 additions & 35 deletions HACKING
@@ -1,7 +1,7 @@
This HACKING file describes the development environment. -*- org -*-

Copyright (C) 2008, 2009, 2011 ViewPlus Technologies, Inc. and Abilitiessoft, Inc.
Copyright (C) 2012, 2013 Swiss Library for the Blind, Visually Impaired and Print Disabled
Copyright (C) 2012, 2013, 2014 Swiss Library for the Blind, Visually Impaired and Print Disabled


Copying and distribution of this file, with or without modification,
Expand All @@ -13,24 +13,21 @@ when hacking liblouis.

* Developing
** Where to get it
The development sources are available through anonymous svn at Google
Code:
The development sources are available through git at github.com:

http://code.google.com/p/liblouis/
https://github.com/liblouis/liblouis

** Build requirements
This distribution uses Automake, Autoconf, and Libtool. If you are
getting the sources from svn (or change configure.ac), you'll need to
getting the sources from git (or change configure.ac), you'll need to
have these tools installed to (re)build. Optionally (if you want to
generate man pages) you'll also need help2man. All of these programs
are available from ftp://ftp.gnu.org/gnu.

** Gnulib
This distribution also uses Gnulib (http://www.gnu.org/software/gnulib)
to share common files, with the files being checked in to svn. If you
want to update from the current gnulib, install gnulib, and then run
gnulib-tool --import
in the top-level directory.
This distribution also uses Gnulib (http://www.gnu.org/software/gnulib). If
you want to update from the current gnulib, install gnulib, and then run
gnulib-tool --import in the top-level directory.

For the record, the first time invocation was
gnulib-tool --import --lib=libgnu --source-base=gnulib \
Expand All @@ -42,9 +39,9 @@ gnulib/m4/gnulib-cache.m4. Given a source checkout of gnulib, you can
update the files with gnulib-tool --import.

** How to build
After getting the sources from svn, with
After getting the sources from git, with

svn checkout http://liblouis.googlecode.com/svn/trunk/ liblouis
git clone https://github.com/liblouis/liblouis.git

and installing the tools above, change to the liblouis directory and
and bootstrap the project with the following command
Expand Down Expand Up @@ -153,13 +150,13 @@ i.e. LIBLOUIS_REVISION and possibly LIBLOUIS_CURRENT and LIBLOUIS_AGE.
** Commit and tag
Commit the changes and tag this version

svn cp https://liblouis.googlecode.com/svn/trunk \
https://liblouis.googlecode.com/svn/tags/liblouis_1_3_8
git tag -s liblouis_2_6_0 -m "Release 2.6.0"
git push origin liblouis_2_6_0

If you know the exact version number that needs to be tagged use

svn cp https://liblouis.googlecode.com/svn/trunk \
https://liblouis.googlecode.com/svn/tags/liblouis_1_3_8 -r 109
git tag -s liblouis_2_6_0 -m "Release 2.6.0" <commit>
git push origin liblouis_2_6_0

** Make the release
Check out a clean copy in a different directory, like /tmp. Run
Expand All @@ -170,32 +167,31 @@ general sanity check. Run make dist. This will produce a tarball.
./autogen.sh && ./configure && make && make distcheck && make dist

** Upload
Upload tarball to Google project page, tag as "featured". This will
put the link on the main project page. Remove "featured" tag from
previous tarball release.
Add the tarball to the liblouis web site, i.e. add it under
$WEBSITE/downloads and add a link to it in $WEBSITE/downloads/index.textile.
See below for instructions on how to update the web site.

** Online documentation
The online documentation is hosted out of subversion of the Google
code site. To check it out

svn co https://liblouis.googlecode.com/svn/documentation \
liblouis-online-documentation

then move the latest built documentation into this directory and check
it in

cd liblouis-online-documentation
cp ../liblouis/doc/liblouis.html .
svn ci liblouis.html -m "Update online documentation"
The online documentation is part of the liblouis web site. To add it to the
site simply copy doc/liblouis.html to $WEBSITE/documentation/liblouis.html.
Make sure you add the proper YAML front matter. Again see below for
instructions on how to update the web site.

** Web site maintenance
The liblouis web site at liblouis.org is maintained with the help of
github pages (https://pages.github.com/). To edit the site just check
out the repo at https://github.com/liblouis/liblouis.github.io. You'll
need to know a few things about Jekyll (http://jekyllrb.com/) and
textile (http://redcloth.org/textile/) the markup that is used to edit
the content. In order to update the site simply edit, commit and push.

For the new release update the project web site. Add a post containing
the current NEWS to the _posts directory.

** Other web updates
Update the Google project page. Add the current NEWS to the front
page.

Also update the page on freshmeat (http://freshmeat.net/projects/liblouis/).

** Announce
Send an announcement to the liblouis list
liblouis-liblouisxml@freelists.org. See ANNOUNCEMENT for an example.


0 comments on commit 71647d6

Please sign in to comment.