====== Developers ======



===== Project at a glance =====

  * [[http://alioth.debian.org/projects/splashy|Splashy project on Alioth]]
  * [[http://packages.qa.debian.org/s/splashy.html|Splashy package on Debian]]

  * "splashy-devel" splashy-devel <~AT> lists.alioth.debian.org
  * "splashy-users" splashy-users <AT~> lists.alioth.debian.org

  * [[http://irc.netsplit.de/webchat/?net=freenode&room=%23splashy|#splashy on irc.freenode.net]] ([[http://irc.netsplit.de/channels/details.php?room=%23splashy&net=freenode|stats]])



===== Debugging =====

See  [[Tips|Tips & Tricks]] for some advice on debugging splashy.

===== Revision control =====

  * [[http://git.debian.org/?p=splashy/splashy.git|Changes and history through Gitweb]]
  * **ssh://git.debian.org/git/splashy/splashy.git**


==== Work Flow ====

  * Need to get a new copy of the repository?
  
  git clone ssh://$ALIOTHUSER@git.debian.org/git/splashy/splashy.git

  * Edit changes locally and need to upload/merge?

  git commit -m "my notes" -a
  git fetch
  git rebase origin
  git push origin

  * Need a read-only copy of the repository?

  git clone git://git.debian.org/git/splashy/splashy.git

  * Need a read-only copy of the repository and you are behind a corporate firewall (no access to port 9418)?

  git clone http://git.debian.org/git/splashy/splashy.git

For more information about Git please read the excellent documentation on X.org/Freedesktop.org:

http://www.freedesktop.org/wiki/Infrastructure/git/Developers

You might want to use the following alias in your **~/.profile**

  # git-pull does not cut it for you?
  alias gitpull='git fetch origin; git rebase origin;'
  # how about git-push?
  alias gitpush='git push; git fetch origin; git rebase origin;'

==== Debian patches ====
Splashy uses quilt for patch management in the debian packages.
Recommended environment settings for quilt are

  export QUILT_PATCHES=debian/patches
  export QUILT_REFRESH_ARGS="-p ab --no-timestamps --no-index"

===== Package automation =====

This is a useful script that I use to build packages for Debian and its derivatives:

<code>
#!/bin/sh
# $Revision: 0.1 $
# 2008-12-23 09:45 EST
# Luis Mondesi <lemsx1@gmail.com>
#
# DESCRIPTION: A simple script to build a Debian package for Splashy.
# It makes the following assumptions:
#
# sudo apt-get install build-essential devscripts automake1.9
# mkdir ~/Develop
# cd ~/Develop
# git clone <git|ssh>://.../splashy.git splashy
# git clone <git|ssh>://.../splashy/debian.git splashy-debian
# ./build_splashy_package
#
# USAGE: cd ~/Develop && ./build_splashy_package
# LICENSE: GPL
#
# BUGS: this script is not for the faint of heart

BUILD_DIR=/tmp

cd ~/Develop

rm -fr $BUILD_DIR/splashy $BUILD_DIR/*splashy*.deb $BUILD_DIR/*splashy*orig.tar.gz $BUILD_DIR/splashy.orig

cp -a splashy $BUILD_DIR/splashy
cp -a splashy-debian/debian $BUILD_DIR/splashy

rm -fr $BUILD_DIR/splashy/.git $BUILD_DIR/debian/.git

cd $BUILD_DIR
cp -a splashy splashy.orig
#tar czf splashy_$VERSION.orig.tar.gz splashy

cd splashy
./autogen.sh
debuild -uc -us

echo splashy and libsplashy1 built on $BUILD_DIR
</code>

===== Subprojects =====

  * [[Gsplashy]]
  * [[Qsplashy]]

===== Bugs tracking and reporting =====

  * [[http://alioth.debian.org/tracker/?group_id=30657|Splashy tracker on Alioth]]
  * [[http://bugs.debian.org/splashy|Debian Bug Tracking System (DBTS)]] (preferred)


===== Mailing lists archives =====

  * [[http://alioth.debian.org/mail/?group_id=30657|All lists at a glance]]
  * [[http://lists.alioth.debian.org/mailman/listinfo/splashy-users|Splashy Users]]
  * [[http://lists.alioth.debian.org/mailman/listinfo/splashy-devel|Splashy Developers]]

===== Notes on Operating Systems =====

  * [[Gentoo]]
  * [[Slackware]]
  * [[Ubuntu]]
  * [[LFS|Linux From Scratch]]