Help » History » Version 23

Chris Cannam, 2010-12-16 01:37 PM

1 1 Chris Cannam
h1. Help for this site
2 2 Chris Cannam
3 8 Chris Cannam
This is a code-repository and project management site for software development carried out in the UK academic audio and music research field.
4 8 Chris Cannam
5 11 Chris Cannam
Run by "":, it is intended to provide a useful facility for researchers who are making software in the course of their work, and for anyone who wishes to make use of such software in the future.  We provide project management and hosting for source code, either published or private.
6 1 Chris Cannam
7 14 Chris Cannam
Although we welcome all audio and music researchers in the UK, we do encourage you to ensure that your follow the proper institutional protocols for managing your work and be careful to respect copyright and your institution's terms and conditions.  If source code control and other facilities are provided by your institution, please, use them; we are also producing documentation and other resources that we hope will help you to do that, so do keep an eye on our "general website":
8 11 Chris Cannam
9 10 Chris Cannam
h2. What facilities do we provide?
10 10 Chris Cannam
11 20 Chris Cannam
This server uses the "Redmine": project management system, with source code repositories managed using the "Mercurial": distributed version control system.  Mercurial is a friendly, popular and modern system which is very effective for managing change histories in source code and much accompanying material.  (It is not so well suited to storing bulk data such as audio test data sets: we hope to provide additional facilities for those.) 
12 10 Chris Cannam
13 11 Chris Cannam
Documentation for Redmine is available in the "Redmine Guide":, and an introductory tutorial about Mercurial can be found at "":, with a number of usage tips at "":  We are going to produce more tutorial material during the coming months.
14 1 Chris Cannam
15 23 Chris Cannam
If you have some existing code or other material which you would like to import into a project on this site, we can help you—in particular, we can easily load data into your Mercurial repository from existing files or from other version control systems for you.  Just drop us a line.
16 21 Chris Cannam
17 3 Chris Cannam
h2. How to contact us
18 1 Chris Cannam
19 22 Chris Cannam
This site manages many software projects run by different people.  But one project here is different—the " Project": is used to manage the development and running of the site itself.  (This page you are reading now is part of the wiki for that project.)  The site is developed in the open, so you can use this project to follow progress and to provide feedback.
20 10 Chris Cannam
21 3 Chris Cannam
If you are having problems with this site, please either:
22 3 Chris Cannam
23 18 Chris Cannam
* use the " Project Forum": ;
24 18 Chris Cannam
* submit a new bug report or feature request in the trackers for the " Project": ; or
25 18 Chris Cannam
* send email to requesting help.
26 3 Chris Cannam
27 17 Chris Cannam
Before submitting a new bug report or feature request, please have a look at the "existing issues": and see whether you can find anything already listed that matches your own requirement.