On Mon, Nov 22, 2010 at 11:47 AM, cstrato <cstrato@aon.at> wrote:

> Dear Marcos,
>
> Please download the source code so that you have access to the README file.
> Regards Christian
>
>
> Dear BioC maintainers,
>
> Since some users have asked me how to access the README file, which
> explains how to install ROOT and xps but is currently only accessible when
> xps is already installed or when you download the source code, my question
> is:
> Would it be possible to make a link to the README file in the Documentation
> section of the BioC packages analogously to the Vignettes?
>


Hi Christian,

The problem is that not all packages have README files (in fact, most of
them do not) and the package detail pages are automatically generated. Our
website creation procedure would need to check if a README file exists
before creating a link to it. This process generally uses only the
information in the DESCRIPTION file to create package detail pages. Because
different parts of the process happen on different machines, it adds
significant complexity to check if a README file exists, then propagate that
information to later stages of the process.

One thing you might want to consider is altering your DESCRIPTION file to
have a URL field. The URL could point to a page where you provide whatever
information you like about installing your package.
You can also provide a bit more installation information in the Description
field of your DESCRIPTION file. This can be more than one line long, as long
as all lines after the first start with one or more spaces.

Dan

	[[alternative HTML version deleted]]

