Hi everybody, I have updated the VIFF homepage a bit and added a link at the top to the issue tracker (I called it "Report bugs" since that I what I think people would use it for).
I also edited the installation guide: http://viff.dk/install.html There were lots of inconsistancies, two spelling errors, URLs left behind in the text... in short it was quite messy and not really fit for end user documentation. Please help me edit the documentation to make it better. The API documentation could also use some updates -- if you cannot contribute code, then please try to contribute documentation updates (this is an excellent way to get started with open source development): * If a function does not document its parameters or return value, then please add them using the "@param foo: bla bla." and "@return: bla bla." comments. If you are unsure as to what parametertypes the function takes, then please ask on the mailing list. * Submitting updates for the website is also easy: Every page has a link to its plain text source at the bottom. Download the source and fix whatever mistakes you find. When you have a fix, then there are several ways for you to contribute them back to us: * You can clone the source using Mercurial -- the repositories are: http://hg.viff.dk/viff/ and http://hg.viff.dk/viff.dk/ Then simply send a mail to the list telling us where we can pull from. This will make sure your patch is attributed correctly to you. * If you do not want to use Mercurial, then no problem -- just send us a mail with the correction. Bigger corrections can be put in the issue tracker. When you correct a file, then please try to note which version you are editing. For the website you can find the files here: http://hg.viff.dk/viff.dk/file/ and when you click on a file you will see the current changeset embedded in the URL -- right now it is 32fd80375443. If you provide this information it will be easier for us to integrate your changes. But even if you forget, we would still like your correction, so please don't hesitate sending them to us. I hope that people will contribute so that we can make VIFF 0.5 have the best possible documentation. -- Martin Geisler _______________________________________________ viff-devel mailing list (http://viff.dk/) viff-devel@viff.dk http://lists.viff.dk/listinfo.cgi/viff-devel-viff.dk
