Sources for SoundScape Renderer (SSR)
=====================================

Download location
-----------------

SSR can be downloaded both from
 - http://spatialaudio.net/ssr/download/
and via a "tagged release" from
 - https://github.com/SoundScapeRenderer/

While releases from the two locations *should* be the same,
in practice it seems that they are not.
noteable differences:
 - github releases do not have autotools files pregenerated
 - github releases do not have the manual pdf precompiled
 - spatialaudio releases lack the source code for the manual pdf

 - github releases include complete APF-tree
 - spatialautio releases only include APF headers
 - github releases include MEX-files

In order to be able to (re)generate the manual pdf, the Debian package tracks
the github release tags rather than the downloadable files from
spatialaudio.net.


DFSG-compliance
---------------

SSR currently ships a PDF without sources, which has therefore been removed from
the Debian package, in order to be DFSG-compliant.
The PDF in question can be downloaded from [1].

[1] https://github.com/SoundScapeRenderer/ssr/blob/master/data/impulse_responses/hrirs/hrirs_fabian_documentation.pdf


Updating the source
-------------------

The source-code is imported directly from github via the following command:

 git-import-orig \
	--pristine-tar --filter-pristine-tar \
	--sign-tags --uscan

Filtering out of unwanted files is done via the 'Files-Excluded' directive in
debian/copyright


CDBS+git-buildpackage
---------------------

This source package uses CDBS and git-buildpackage.  NMUs need not (but
are encouraged to) make special use of these tools.  In particular, the
debian/control.in file can be completely ignored.

More info here: http://wiki.debian.org/CDBS+git-buildpackage

git-tuneclone.sh
----------------

This package comes with a script 'debian/git-tuneclone.sh'.
Running it after a fresh clone of the packaging repository
will fine-tune your local copy, namely:
- make git ignore any .pc/ directory (created by quilt)
- enable the "-follow-tags" when running 'git-push', so it's harder
  to forget to push packaging tags along with the branches.
- do an initial checkout of the 3 packaging branches (master, pristine-tar,
  upstream)
The script only needs to run once (though running it multiple times shouldn't
matter).
You are of course free to *not* run the script, if you prefer.

 -- IOhannes m zmölnig (Debian/GNU) <umlaeute@debian.org>  Tue, 11 Nov 2015 11:11:03 +0100

