On Tue, Apr 3, 2012 at 12:16 PM, Greg Von Kuster <greg(a)bx.psu.edu> wrote:
>
> On Apr 3, 2012, at 6:07 AM, Peter Cock wrote:
>
>> On Mon, Apr 2, 2012 at 6:41 PM, Greg Von Kuster <greg(a)bx.psu.edu> wrote:
>>>
>>> On Mar 24, 2012, at 7:30 AM, Peter Cock wrote:
>>>>
>>>> Have you seen the README file that comes with the
>>>> Blast2GO wrapper? Perhaps the 'install from toolshed'
>>>> could be tweaked to make this kind of documentation
>>>> more visible...
>>>
>>> If you are installing a single repository that contains a file named one of
>>> (case is ignored) readme, readme.txt, read_me, read_me.txt, the contents of
>>> the file will be displayed on the "tool panel section selection page". An
>>> example using the antismash repository on the main tool shed is below. This
>>> new feature is available in change set revision 6945:5ea04ccb61e8, which is
>>> currently running on the Galaxy tool shed and our central development
>>> repository. It will be available in the next Galaxy distribution.
>>
>> Great. In this case I've actually called the file blast2go.txt (to match
>> the use of blast2go.xml and blast2go.py). I didn't want to use a
>> generic name like README since there could be other tools
>> installed in the same folder (this predates the auto-install system).
>> Is this naming pattern common used enough to justify including in
>> the Galaxy Tool Shed code for spotting a README file?
>
>
> Since the "read me" file contains instructions for installing the tools
> in the repository, would it be better to assume only 1 installation file
> that includes different instructions per contained tool if necessary?
> If multiple "read me" files are allowed per repository, they would all
> have to be merged together with the entire content displayed on
> the tool panel section selection screen anyway, so allowing only
> a single file would be better. The "read me" in your blast2go
> repository is named blast2go.txt, so I suppose we could expand
> the read me file name list to include <repository name>.txt. I'll do this.
Hi Greg,
Could you include <repository name>.txt on the list of README
filenames looked for by the ToolShed as you said please?
I've just checked and it isn't working at the moment. e.g. blast2go,
seq_rename, clinod, venn_list, ... - in fact most of my tools :(
Thanks,
Peter