Tips » History » Version 12

Chris Cannam, 2011-04-13 04:52 PM

1 1 Chris Cannam
h1. Tips of the Day
2 1 Chris Cannam
3 1 Chris Cannam
*Show your face*
4 1 Chris Cannam
5 1 Chris Cannam
If you have a "Gravatar": image, it will appear alongside your user name in "activity pages":/activity and the like.  If you'd like to set up an image for this, just hop along to "Gravatar": and register an image using your email address as it appears on this site.
6 1 Chris Cannam
7 1 Chris Cannam
*Import an existing repository*
8 1 Chris Cannam
9 1 Chris Cannam
Have an existing repository in Subversion, Mercurial or another system that you'd like to import with all of its history?
10 1 Chris Cannam
11 2 Chris Cannam
You can do this yourself with the Mercurial @convert@ extension, but you may find it simpler to "ask us to do it for you"  Just drop us a line, tell us your project name, and let us know where your existing repository lives.
12 3 Chris Cannam
13 3 Chris Cannam
*Project hosted elsewhere?*
14 3 Chris Cannam
15 4 Chris Cannam
You can create a project on this site even if the code itself is hosted somewhere else, if you want to make it easier for other researchers to find your work.  Just include the Homepage link when you create the project, and be sure to include enough of a description to make it clear what the project is about.
16 3 Chris Cannam
17 3 Chris Cannam
If you don't need a repository hosted here, go to your project's Settings and in the "Modules" tab, switch off "Repository".
18 5 Chris Cannam
19 5 Chris Cannam
*Need help?*
20 5 Chris Cannam
21 6 Chris Cannam
Confused?  Don't know where to begin?  Messed something up in your project settings or repository?
22 6 Chris Cannam
23 6 Chris Cannam
We can help -- ask us!  We're nice people.  Follow the "Help":/projects/soundsoftware-site/wiki/Help link (it's in the bar at the top of every page) and read the "How to contact us" section.
24 7 Chris Cannam
25 7 Chris Cannam
*Tell us your institution*
26 7 Chris Cannam
27 7 Chris Cannam
There is now an _Institution_ setting in your "Account page":/my/account.
28 7 Chris Cannam
29 7 Chris Cannam
If you registered here before this setting was added, it would be great if you could find a moment to go back and let us know which research institution you're affiliated with.
30 7 Chris Cannam
31 7 Chris Cannam
32 7 Chris Cannam
33 7 Chris Cannam
*Document your code!*
34 7 Chris Cannam
35 9 Chris Cannam
If you use "Doxygen": or "Javadoc": to add inline documentation to code that you put in your project repository, then your documentation will be extracted automatically and made available in a "Code docs" page for the project!
36 7 Chris Cannam
37 7 Chris Cannam
See the "Vamp Plugin SDK":/projects/vamp-plugin-sdk project for an example (look for the "Code docs" link in the navigation).
38 7 Chris Cannam
39 8 Chris Cannam
"Read more about this":/projects/soundsoftware-site/wiki/Docgen.
40 10 Chris Cannam
41 10 Chris Cannam
*Make your licence intentions clear*
42 10 Chris Cannam
43 11 Chris Cannam
If your project is public, or might be public one day, you really should have some sort of licence statement in it so people know what they can do with it.  The default copyright position, if you don't include any licence at all, is that nobody can do anything much with your software.
44 10 Chris Cannam
45 12 Chris Cannam
Consider adding one of the common open source licences ("GPL" or "BSD": if you want to make your code freely re-usable.  But even if you don't want to do that, please, at least make your usage intentions clear in the accompanying text.
46 10 Chris Cannam
47 11 Chris Cannam
(While you're at it, please double-check that you're not incorporating anyone else's code whose terms aren't compatible with your own!)