simple-scan-team team mailing list archive

[Michael Nagel <ubuntu@xxxxxxxxxxxxxxxxx>]

Michael Nagel has proposed merging lp:~nailor/simple-scan/readme into lp:simple-scan.

Requested reviews:
  Simple Scan Development Team (simple-scan-team)

For more details, see:
https://code.launchpad.net/~nailor/simple-scan/readme/+merge/119567

improve README
-- 
https://code.launchpad.net/~nailor/simple-scan/readme/+merge/119567
Your team Simple Scan Development Team is requested to review the proposed merge of lp:~nailor/simple-scan/readme into lp:simple-scan.

=== modified file 'README'
--- README	2009-11-18 06:48:35 +0000
+++ README	2012-08-14 15:08:34 +0000
@@ -1,1 +1,101 @@
-https://launchpad.net/simple-scan
+SIMPLE SCAN
+===========
+
+This is the source code to "Simple Scan" a simple GNOME scanning application,
+using the sane scanning libraries.
+
+The Simple Scan homepage with further information is located at:
+https://launchpad.net/simple-scan
+
+
+
+BUILDING
+========
+
+Unfortunatly Simple Scan is a little bit picky about dependencies when building.
+The latest version of Simple Scan is primarily developed on
+
+- Ubuntu 12.04 LTS
+
+and know to successfully build using the following commands:
+
+0) bzr branch lp:simple-scan simple-scan && cd simple-scan
+1) sudo apt-get build-dep simple-scan
+2) sudo apt-get install valac-0.16 vala-0.16
+3) sudo update-alternatives --config valac # select vala-0.16
+4a) ./autogen.sh                           # system-wide installation
+4b) ./autogen.sh --prefix=`pwd`/install    # for development purposes
+5) make
+6) make install
+7) ./install/simple-scan
+
+
+
+DEBUGGING
+=========
+
+The following tips might be helpful when debugging.
+
+There is a --debug command line switch to enable more verbose logging:
+./install/simple-scan --debug
+
+Log messages can also be found in the $HOME/.cache/simple-scan folder.
+
+Simple Scan config goes to $HOME/.gconf/apps/simple-scan/%gconf.xml
+and that file is best edited with the gconf-editor tool.
+
+If you don't have a scanner ready, you can use a virtual "test" scanner:
+./install/simple-scan --debug test
+
+When debugging hardware issues always check xsane and especially scanimage.
+http://xsane.org/
+http://www.sane-project.org/man/scanimage.1.html
+
+
+
+CONTRIBUTING
+============
+
+The preferred way to contribute code to Simple Scan is
+to create a merge request on Launchpad.
+
+Creating a merge request on Launchpad involves creating an account:
+https://login.launchpad.net/+new_account
+You need set up a SSH key with Launchpad:
+https://launchpad.net/~/+editsshkeys
+How to configure bazaar (whoami) and create commits: 
+http://doc.bazaar.canonical.com/latest/en/mini-tutorial/
+Push the changes to a personal repository on Launchpad:
+bzr push lp:~$USER/simple-scan/$BRANCHNAME
+where $USER is your Launchpad Id and $COMMENT is a newly created branch name.
+Propose merging your new branch to the master branch on:
+https://code.launchpad.net/~
+
+If everything is set up correctly the following should work:
+FEATURE="foobar"
+LAUNCHPADID="name"
+bzr branch lp:simple-scan simple-scan-$FEATURE && cd simple-scan-$FEATURE
+bzr add .
+bzr commit -m "add $FEATURE"
+bzr push lp:~$LAUNCHPADID/simple-scan/$FEATURE
+xdg-open "https://code.launchpad.net/~";
+
+If this does not work for you, feel free to contact us
+via one of the channels listed below.
+
+
+
+CONTACT
+=======
+
+Websites:
+https://launchpad.net/simple-scan
+https://bugs.launchpad.net/simple-scan
+https://answers.launchpad.net/simple-scan
+
+Mailing Lists:
+https://launchpad.net/~simple-scan-users
+https://launchpad.net/~simple-scan-team
+
+IRC:
+#simple-scan on Freenode ( irc.ubuntu.com )