# HG changeset patch # User Chris Cannam # Date 1558628371 -3600 # Node ID 86a76c23e967fb922af089e93d97adbc07a615a6 # Parent 51af92c83dfcc535abcec4d4b6b8c0813d8c9377 Further notes diff -r 51af92c83dfc -r 86a76c23e967 CONTRIBUTING.md --- 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. diff -r 51af92c83dfc -r 86a76c23e967 README.md --- 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 diff -r 51af92c83dfc -r 86a76c23e967 qm-dsp.pro.user --- 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 @@ - - - - RunConfiguration0-Arguments - - - - RunConfiguration0-BaseEnvironmentBase - 2 - - - RunConfiguration0-Executable - - - - RunConfiguration0-RunConfiguration.name - Custom Executable - - - RunConfiguration0-UseTerminal - false - - - RunConfiguration0-UserEnvironmentChanges - - - - RunConfiguration0-UserName - - - - RunConfiguration0-UserSetName - false - - - RunConfiguration0-WorkingDirectory - $BUILDDIR - - - RunConfiguration0-type - ProjectExplorer.CustomExecutableRunConfiguration - - - activeRunConfiguration - 0 - - - activebuildconfiguration - Debug - - - buildConfiguration-Debug - - Debug - 0 - 0 - 2 - - - - buildConfiguration-Release - - Release - 0 - 0 - - - - buildconfiguration-Debug-buildstep0 - - Debug - - Apple_PubSub_Socket_Render=/tmp/launch-CVQ5Yw/Render - COMMAND_MODE=unix2003 - DISPLAY=/tmp/launch-7rJXTo/:0 - HOME=/Users/mathieub - LOGNAME=mathieub - PATH=/Developer/Tools/Qt:/usr/bin:/bin:/usr/sbin:/sbin - QTDIR=/usr/local/Qt4.7 - SECURITYSESSIONID=82d590 - SHELL=/bin/bash - SSH_AUTH_SOCK=/tmp/launch-moi9U2/Listeners - TMPDIR=/var/folders/V7/V7hFV43NHuGIiTNXMruZKU+++TM/-Tmp-/ - USER=mathieub - __CF_USER_TEXT_ENCODING=0x1F6:0:0 - - - /Users/mathieub/Data/CODE/qm-dsp/qm-dsp.pro - -spec - macx-g++ - -r - - /usr/bin/qmake - false - /Users/mathieub/Data/CODE/qm-dsp - - - - buildconfiguration-Debug-buildstep1 - - Debug - - Apple_PubSub_Socket_Render=/tmp/launch-CVQ5Yw/Render - COMMAND_MODE=unix2003 - DISPLAY=/tmp/launch-7rJXTo/:0 - HOME=/Users/mathieub - LOGNAME=mathieub - PATH=/Developer/Tools/Qt:/usr/bin:/bin:/usr/sbin:/sbin - QTDIR=/usr/local/Qt4.7 - SECURITYSESSIONID=82d590 - SHELL=/bin/bash - SSH_AUTH_SOCK=/tmp/launch-moi9U2/Listeners - TMPDIR=/var/folders/V7/V7hFV43NHuGIiTNXMruZKU+++TM/-Tmp-/ - USER=mathieub - __CF_USER_TEXT_ENCODING=0x1F6:0:0 - - false - - -w - - /usr/bin/make - true - /Users/mathieub/Data/CODE/qm-dsp - - - - buildconfiguration-Debug-cleanstep0 - - Debug - true - - clean - - - - - buildconfiguration-Release-buildstep0 - - Release - - - - buildconfiguration-Release-buildstep1 - - Release - - - - buildconfiguration-Release-cleanstep0 - - Release - - - - buildconfigurations - - Debug - Release - - - - buildstep0 - - - - - - - buildstep1 - - - - - - buildsteps - - trolltech.qt4projectmanager.qmake - trolltech.qt4projectmanager.make - - - - cleanstep0 - - - true - - - - cleansteps - - trolltech.qt4projectmanager.make - - - - defaultFileEncoding - System - - - project - - -