[med-svn] [concavity] 01/01: add README.test with notes+add it to package's docs

[Tatiana Malygina]

This is an automated email from the git hooks/post-receive script.

latticetower-guest pushed a commit to branch master
in repository concavity.

commit 823372317e06c6d2188cf3166722bd193eab6134
Author: latticetower-guest <merlettaia at gmail.com>
Date:   Wed Jun 8 09:40:10 2016 +0000

    add README.test with notes+add it to package's docs
---
 debian/README.test | 43 +++++++++++++++++++++++++++++++++++++++++++
 debian/changelog   |  1 +
 debian/docs        |  2 ++
 3 files changed, 46 insertions(+)

diff --git a/debian/README.test b/debian/README.test
new file mode 100644
index 0000000..def9592
--- /dev/null
+++ b/debian/README.test
@@ -0,0 +1,43 @@
+Notes on how this package can be tested.
+────────────────────────────────────────
+
+This package can be tested by executing
+
+    sh installation-test
+
+in order to confirm its integrity.
+
+To test manually, run 
+
+    concavity -conservation conservation_data/1G6C 1G6C.pdb test1
+
+In this call 1G6C.pdb can be replaced by other PDB-file, for example, 
+taken from RCSB PDB database [1]. 
+Meaning of `-conservation` optional parameter and other available optional 
+parameters are explicitly described in this package's README.txt.
+
+Note, that second positional argument ('test1' in above example) must be output 
+suffix for naming resulting files. Providing path instead of suffix like in 
+this call: 
+
+    concavity 1G6C.pdb examples/test1
+
+- produces error (it is normal behavior):
+
+  GAPS ERROR: No such file or directory
+  Unable to open file 1G6C_examples/test1.dx
+
+Output is always saved to current folder. Make sure to cd to correct working 
+directory before running concavity!
+
+Note that PyMol script produced by concavity (.pml file) is not tested by this 
+testsuite. If you want to run this script from different harddrive/other PC, 
+make sure to copy also .pdb and .dx files produced by concavity, and save them 
+to the same folder where .pml file will be located.
+
+References:
+
+[1]: RCSB PDB database (one of the possible sources of .pdb files)
+    http://www.rcsb.org/pdb/home/home.do
+[2]: PyMol
+    http://pymol.org/
diff --git a/debian/changelog b/debian/changelog
index b2b6960..7dcccbc 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -2,6 +2,7 @@ concavity (0.1+dfsg.1-1) UNRELEASED; urgency=medium
 
   * Team upload.
   * Remove ply.* files. Closes: #822382
+  * added README.test, mention it and example test in docs
 
  -- Tatiana Malygina <merlettaia at gmail.com>  Tue, 07 Jun 2016 22:28:38 +0000
 
diff --git a/debian/docs b/debian/docs
index 71dfd5b..3e4b960 100644
--- a/debian/docs
+++ b/debian/docs
@@ -1 +1,3 @@
 README.txt
+debian/README.test
+debian/tests/installation-test

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-med/concavity.git