@@ -1,6 +1,5 @@ - $Id: README,v 1.17 2007/12/07 02:00:42 k Exp $ - - Copyright (C) 2001-2007 Toshiaki Katayama <k@bioruby.org> +Copyright (C) 2001-2007 Toshiaki Katayama <k@bioruby.org> + 2008 Jan Aerts <jandot@bioruby.org> = BioRuby @@ -43,13 +42,24 @@ The stable release is freely available from the BioRuby website. * ((<URL:http://bioruby.org/archive/>)) +--- git + +If you need the latest development version, this is provided at + + * ((<URL:http://github.com/bioruby/bioruby>)) + +and can be obtained by the following procedure: + + % git clone git://github.com/bioruby/bioruby.git + --- CVS -If you need the latest development version, anonymous CVS is provided at +CVS is now deprecated as source control has moved to github. Please use git +instead of CVS. For historical purposes: the anonymous CVS was provided at * ((<URL:http://cvs.bioruby.org/>)) -and can be obtained by the following procedure. +and could be obtained by the following procedure. % cvs -d :pserver:cvs@code.open-bio.org:/home/repository/bioruby login CVS password: cvs (login with a password 'cvs' for the first time) README.rdoc @@ -1,9 +1,7 @@ = README.DEV Copyright:: Copyright (C) 2005, 2006 Toshiaki Katayama <k@bioruby.org> -Copyright:: Copyright (C) 2006 Jan Aerts <jan.aerts@bbsrc.ac.uk> - - $Id: README.DEV,v 1.14 2007/04/05 23:35:39 trevor Exp $ +Copyright:: Copyright (C) 2006, 2008 Jan Aerts <jandot@bioruby.org> = HOW TO CONTRIBUTE TO THE BIORUBY PROJECT? @@ -21,6 +19,12 @@ how to contribute your code to the BioRuby distribution. We would like to include your contribution as long as the scope of your module meets the field of bioinformatics. +== Git + +Bioruby is now under git source control at http://github.com/bioruby/bioruby. +There are two basic ways to contribute: with patches or pull requests. Both are +explained on the bioruby wiki at http://bioruby.open-bio.org/wiki. + = LICENSE If you would like your module to be included in the BioRuby distribution, @@ -48,8 +52,8 @@ You will need to follow the typical coding styles of the BioRuby modules: == Comments -Don't use <tt>=begin</tt> and <tt>=end</tt> blocks for comments. If you need to add -comments, include it in the RDoc documentation. +Don't use <tt>=begin</tt> and <tt>=end</tt> blocks for comments. If you need to +add comments, include it in the RDoc documentation. == Documentation should be written in the RDoc format in the source code @@ -81,8 +85,6 @@ The header should be formatted as follows: # # License:: The Ruby License # - # $ I d: $ - # # == Description # # This file contains classes that implement an interface to the Hoge database. @@ -105,13 +107,6 @@ The header should be formatted as follows: end # Bio -In the above sample, the '$ I d : $' (without spaces) will be automatically -changed into something like - - $Id: README.DEV,v 1.14 2007/04/05 23:35:39 trevor Exp $ - -when commiting to the CVS repository for the first time. - === of classes and methods within those files Classes and methods should be documented in a standardized format, as in the @@ -285,8 +280,6 @@ a new module or making changes on existing modules. = MAINTENANCE -Finally, please maintain the code you've contributed. The BioRuby -staff is willing to give you CVS privileges if needed. -Please let us know (on the bioruby list) before you commit, so that users -can discuss on the change. +Finally, please maintain the code you've contributed. Please let us know (on +the bioruby list) before you commit, so that users can discuss on the change. README_DEV.rdoc 34b7693f74de2358759e955d8ce36cfe15e64b54 Jan Aerts jan.aerts@gmail.com http://github.com/latvianlinuxgirl/bioruby/commit/a61b16163d3ca74f3f7c8d8e8f03f5f8c68dee60 a61b16163d3ca74f3f7c8d8e8f03f5f8c68dee60

2008-06-23T12:49:18-07:00

Edited README.rdoc and README_DEV.rdoc to reflect move from CVS to git. d58b6ea8ba72e7de3b27acb2df34cb5c82802cb6 Jan Aerts jan.aerts@gmail.com