Help » History » Version 35

Chris Cannam, 2013-01-25 04:00 PM

1 1 Chris Cannam
h1. Help for this site
2 2 Chris Cannam
3 27 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, and by other researchers worldwide who are working on code relevant to the audio and music research.
4 8 Chris Cannam
5 29 Chris Cannam
Run by "":, it is 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 31 Chris Cannam
Although we welcome researchers from all UK institutions and elsewhere, please make sure you follow your institution's protocols for managing your work and be careful to respect copyright and your institution's code of conduct.  (Read the "terms and conditions of use":/projects/soundsoftware-site/wiki/TandCs for this site.)  If source code control and other facilities are provided by your institution, please use them: we publish documentation and other resources that we hope will help you to do that, so check out our "general website":
8 1 Chris Cannam
9 32 Chris Cannam
h2. What facilities do we provide here?
10 27 Chris Cannam
11 10 Chris Cannam
12 27 Chris Cannam
This server uses a project management system based on "Redmine":, 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.) 
13 1 Chris Cannam
14 33 Chris Cannam
We also provide and promote the "EasyMercurial": user interface for Mercurial (shown right), a free, friendly way to get going with version control.
15 1 Chris Cannam
16 27 Chris Cannam
h2. Help using this site
17 27 Chris Cannam
18 27 Chris Cannam
 * "Get started with your software and our project site":
19 27 Chris Cannam
 * [[ExternalHosting|How to set up projects that track code hosted elsewhere]]
20 27 Chris Cannam
 * [[Publications|How to associate your publications with your project]]
21 27 Chris Cannam
 * [[Docgen|How to show documentation extracted from your code]]
22 27 Chris Cannam
23 27 Chris Cannam
h2. Help using Mercurial version control with this site
24 27 Chris Cannam
25 27 Chris Cannam
 * "Two introductory EasyMercurial videos":
26 27 Chris Cannam
 * "Why Version Control?":
27 27 Chris Cannam
 * "What's the difference between Mercurial and git?":
28 35 Chris Cannam
 * "An introductory tutorial about Mercurial": (using the command-line tool)
29 35 Chris Cannam
 * "Mercurial usage tips":
30 27 Chris Cannam
31 27 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"
32 21 Chris Cannam
33 3 Chris Cannam
h2. How to contact us
34 1 Chris Cannam
35 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.
36 10 Chris Cannam
37 3 Chris Cannam
If you are having problems with this site, please either:
38 3 Chris Cannam
39 18 Chris Cannam
* use the " Project Forum": ;
40 18 Chris Cannam
* submit a new bug report or feature request in the trackers for the " Project": ; or
41 18 Chris Cannam
* send email to requesting help.
42 3 Chris Cannam
43 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.