Mercurial > hg > qm-dsp

changeset 448:d3b3f07cce2a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Further notes
author Chris Cannam <c.cannam@qmul.ac.uk>
date Thu, 23 May 2019 17:19:31 +0100
parents 20e6297c8394
children ae8343f56d77
files CONTRIBUTING.md README.md qm-dsp.pro.user
diffstat 3 files changed, 17 insertions(+), 219 deletions(-) [+]
line wrap: on
line diff
--- a/CONTRIBUTING.md	Thu May 23 15:18:24 2019 +0100
+++ b/CONTRIBUTING.md	Thu May 23 17:19:31 2019 +0100
@@ -2,17 +2,17 @@
 Contributing
 ============
 
-The qm-dsp library is currently maintained in a Github repository at
+The qm-dsp library is maintained in a Github repository at
 https://github.com/c4dm/qm-dsp.
 
 
 Reporting bugs
 --------------
 
-Please use the Github repo issue tracker for bug reports. Try to make
-them as specific as possible, for example by including some input that
-triggers a particular behaviour, and describing how that behaviour
-differs from what you expected.
+Please use Github issues for bug reports. Try to make them as specific
+as possible. For example, describe an input that triggers some
+particular behaviour, and tell us how that behaviour differs from what
+you expected.
 
 If your bug can be reproduced by processing an audio file using one of
 the QM Vamp Plugins (https://github.com/c4dm/qm-vamp-plugins), which
@@ -59,11 +59,11 @@
 Code style
 ----------
 
- * The C++ standard used is C++98, except for the unit test code which
-   may use up to C++14
+ * C++ code must compile with the C++98 standard, except for the unit
+   tests which are C++14
 
- * Classes are named `LikeThis`; functions, methods, and local
-   variables `likeThis`; class member variables `m_likeThis`
+ * Classes are named `LikeThis` - functions, methods, and local
+   variables `likeThis` - class member variables `m_likeThis`
 
  * Indentation is four spaces at a time (no tabs)
 
@@ -71,9 +71,9 @@
    at the start of a function or class definition where it gets a line
    of its own
 
- * Always use braces around any conditional block that occupies its
-   own line
+ * Please use braces around any conditional or loop block that
+   occupies its own line
 
-Some older or contributed code in this library does not follow these
+Some of the older code in this library does not follow these
 guidelines - usually this means the code needs to be updated.
 
--- a/README.md	Thu May 23 15:18:24 2019 +0100
+++ b/README.md	Thu May 23 17:19:31 2019 +0100
@@ -6,13 +6,13 @@
 Music Informatics purposes developed at Queen Mary, University of
 London.
 
-Despite the name "qm-dsp", it is not "the official QM DSP library",
-just a library for DSP that happens to have been written at QM. It got
-this name by being released publicly first.
-
 It is used by [QM Vamp Plugins](http://isophonics.net/QMVampPlugins)
 amongst other things.
 
+Despite the assertive name "qm-dsp", it is not "the official QM DSP
+library", just one library for DSP that happens to have been written
+at QM. It got this name because nothing else was using it at the time.
+
 
 Compiling the library
 ---------------------
@@ -28,7 +28,7 @@
 test`. Tests require the Boost library.
 
 
-License
+Licence
 -------
 
 This program is free software; you can redistribute it and/or modify
--- a/qm-dsp.pro.user	Thu May 23 15:18:24 2019 +0100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,202 +0,0 @@
-<!DOCTYPE QtCreatorProject>
-<qtcreator>
- <data>
-  <variable>RunConfiguration0-Arguments</variable>
-  <valuelist type="QVariantList"/>
- </data>
- <data>
-  <variable>RunConfiguration0-BaseEnvironmentBase</variable>
-  <value type="int">2</value>
- </data>
- <data>
-  <variable>RunConfiguration0-Executable</variable>
-  <value type="QString"></value>
- </data>
- <data>
-  <variable>RunConfiguration0-RunConfiguration.name</variable>
-  <value type="QString">Custom Executable</value>
- </data>
- <data>
-  <variable>RunConfiguration0-UseTerminal</variable>
-  <value type="bool">false</value>
- </data>
- <data>
-  <variable>RunConfiguration0-UserEnvironmentChanges</variable>
-  <valuelist type="QVariantList"/>
- </data>
- <data>
-  <variable>RunConfiguration0-UserName</variable>
-  <value type="QString"></value>
- </data>
- <data>
-  <variable>RunConfiguration0-UserSetName</variable>
-  <value type="bool">false</value>
- </data>
- <data>
-  <variable>RunConfiguration0-WorkingDirectory</variable>
-  <value type="QString">$BUILDDIR</value>
- </data>
- <data>
-  <variable>RunConfiguration0-type</variable>
-  <value type="QString">ProjectExplorer.CustomExecutableRunConfiguration</value>
- </data>
- <data>
-  <variable>activeRunConfiguration</variable>
-  <value type="int">0</value>
- </data>
- <data>
-  <variable>activebuildconfiguration</variable>
-  <value type="QString">Debug</value>
- </data>
- <data>
-  <variable>buildConfiguration-Debug</variable>
-  <valuemap type="QVariantMap">
-   <value key="ProjectExplorer.BuildConfiguration.DisplayName" type="QString">Debug</value>
-   <value key="QtVersionId" type="int">0</value>
-   <value key="ToolChain" type="int">0</value>
-   <value key="buildConfiguration" type="int">2</value>
-  </valuemap>
- </data>
- <data>
-  <variable>buildConfiguration-Release</variable>
-  <valuemap type="QVariantMap">
-   <value key="ProjectExplorer.BuildConfiguration.DisplayName" type="QString">Release</value>
-   <value key="QtVersionId" type="int">0</value>
-   <value key="buildConfiguration" type="int">0</value>
-  </valuemap>
- </data>
- <data>
-  <variable>buildconfiguration-Debug-buildstep0</variable>
-  <valuemap type="QVariantMap">
-   <value key="ProjectExplorer.BuildConfiguration.DisplayName" type="QString">Debug</value>
-   <valuelist key="abstractProcess.Environment" type="QVariantList">
-    <value type="QString">Apple_PubSub_Socket_Render=/tmp/launch-CVQ5Yw/Render</value>
-    <value type="QString">COMMAND_MODE=unix2003</value>
-    <value type="QString">DISPLAY=/tmp/launch-7rJXTo/:0</value>
-    <value type="QString">HOME=/Users/mathieub</value>
-    <value type="QString">LOGNAME=mathieub</value>
-    <value type="QString">PATH=/Developer/Tools/Qt:/usr/bin:/bin:/usr/sbin:/sbin</value>
-    <value type="QString">QTDIR=/usr/local/Qt4.7</value>
-    <value type="QString">SECURITYSESSIONID=82d590</value>
-    <value type="QString">SHELL=/bin/bash</value>
-    <value type="QString">SSH_AUTH_SOCK=/tmp/launch-moi9U2/Listeners</value>
-    <value type="QString">TMPDIR=/var/folders/V7/V7hFV43NHuGIiTNXMruZKU+++TM/-Tmp-/</value>
-    <value type="QString">USER=mathieub</value>
-    <value type="QString">__CF_USER_TEXT_ENCODING=0x1F6:0:0</value>
-   </valuelist>
-   <valuelist key="abstractProcess.arguments" type="QVariantList">
-    <value type="QString">/Users/mathieub/Data/CODE/qm-dsp/qm-dsp.pro</value>
-    <value type="QString">-spec</value>
-    <value type="QString">macx-g++</value>
-    <value type="QString">-r</value>
-   </valuelist>
-   <value key="abstractProcess.command" type="QString">/usr/bin/qmake</value>
-   <value key="abstractProcess.enabled" type="bool">false</value>
-   <value key="abstractProcess.workingDirectory" type="QString">/Users/mathieub/Data/CODE/qm-dsp</value>
-  </valuemap>
- </data>
- <data>
-  <variable>buildconfiguration-Debug-buildstep1</variable>
-  <valuemap type="QVariantMap">
-   <value key="ProjectExplorer.BuildConfiguration.DisplayName" type="QString">Debug</value>
-   <valuelist key="abstractProcess.Environment" type="QVariantList">
-    <value type="QString">Apple_PubSub_Socket_Render=/tmp/launch-CVQ5Yw/Render</value>
-    <value type="QString">COMMAND_MODE=unix2003</value>
-    <value type="QString">DISPLAY=/tmp/launch-7rJXTo/:0</value>
-    <value type="QString">HOME=/Users/mathieub</value>
-    <value type="QString">LOGNAME=mathieub</value>
-    <value type="QString">PATH=/Developer/Tools/Qt:/usr/bin:/bin:/usr/sbin:/sbin</value>
-    <value type="QString">QTDIR=/usr/local/Qt4.7</value>
-    <value type="QString">SECURITYSESSIONID=82d590</value>
-    <value type="QString">SHELL=/bin/bash</value>
-    <value type="QString">SSH_AUTH_SOCK=/tmp/launch-moi9U2/Listeners</value>
-    <value type="QString">TMPDIR=/var/folders/V7/V7hFV43NHuGIiTNXMruZKU+++TM/-Tmp-/</value>
-    <value type="QString">USER=mathieub</value>
-    <value type="QString">__CF_USER_TEXT_ENCODING=0x1F6:0:0</value>
-   </valuelist>
-   <value key="abstractProcess.IgnoreReturnValue" type="bool">false</value>
-   <valuelist key="abstractProcess.arguments" type="QVariantList">
-    <value type="QString">-w</value>
-   </valuelist>
-   <value key="abstractProcess.command" type="QString">/usr/bin/make</value>
-   <value key="abstractProcess.enabled" type="bool">true</value>
-   <value key="abstractProcess.workingDirectory" type="QString">/Users/mathieub/Data/CODE/qm-dsp</value>
-  </valuemap>
- </data>
- <data>
-  <variable>buildconfiguration-Debug-cleanstep0</variable>
-  <valuemap type="QVariantMap">
-   <value key="ProjectExplorer.BuildConfiguration.DisplayName" type="QString">Debug</value>
-   <value key="cleanConfig" type="bool">true</value>
-   <valuelist key="makeargs" type="QVariantList">
-    <value type="QString">clean</value>
-   </valuelist>
-  </valuemap>
- </data>
- <data>
-  <variable>buildconfiguration-Release-buildstep0</variable>
-  <valuemap type="QVariantMap">
-   <value key="ProjectExplorer.BuildConfiguration.DisplayName" type="QString">Release</value>
-  </valuemap>
- </data>
- <data>
-  <variable>buildconfiguration-Release-buildstep1</variable>
-  <valuemap type="QVariantMap">
-   <value key="ProjectExplorer.BuildConfiguration.DisplayName" type="QString">Release</value>
-  </valuemap>
- </data>
- <data>
-  <variable>buildconfiguration-Release-cleanstep0</variable>
-  <valuemap type="QVariantMap">
-   <value key="ProjectExplorer.BuildConfiguration.DisplayName" type="QString">Release</value>
-  </valuemap>
- </data>
- <data>
-  <variable>buildconfigurations</variable>
-  <valuelist type="QVariantList">
-   <value type="QString">Debug</value>
-   <value type="QString">Release</value>
-  </valuelist>
- </data>
- <data>
-  <variable>buildstep0</variable>
-  <valuemap type="QVariantMap">
-   <value key="ProjectExplorer.BuildConfiguration.DisplayName" type="QString"></value>
-   <value key="mkspec" type="QString"></value>
-  </valuemap>
- </data>
- <data>
-  <variable>buildstep1</variable>
-  <valuemap type="QVariantMap">
-   <value key="ProjectExplorer.BuildConfiguration.DisplayName" type="QString"></value>
-  </valuemap>
- </data>
- <data>
-  <variable>buildsteps</variable>
-  <valuelist type="QVariantList">
-   <value type="QString">trolltech.qt4projectmanager.qmake</value>
-   <value type="QString">trolltech.qt4projectmanager.make</value>
-  </valuelist>
- </data>
- <data>
-  <variable>cleanstep0</variable>
-  <valuemap type="QVariantMap">
-   <value key="ProjectExplorer.BuildConfiguration.DisplayName" type="QString"></value>
-   <value key="clean" type="bool">true</value>
-  </valuemap>
- </data>
- <data>
-  <variable>cleansteps</variable>
-  <valuelist type="QVariantList">
-   <value type="QString">trolltech.qt4projectmanager.make</value>
-  </valuelist>
- </data>
- <data>
-  <variable>defaultFileEncoding</variable>
-  <value type="QByteArray">System</value>
- </data>
- <data>
-  <variable>project</variable>
-  <valuemap type="QVariantMap"/>
- </data>
-</qtcreator>