[Chandler-dev] Question about README.<OS> files that get installed with Chandler

Sheila Mooney sheila at osafoundation.org
Thu Jul 5 16:09:09 PDT 2007


I think the issue is that everything is on the wiki, the landing  
page, the license file, the known bugs. If the user doesn't have  
internet access, they won't see any of that. I was initially just  
going to keep these files very short but Katie brought up this issue  
so I just wanted to take it to the list to see if people thought it  
was something we should be addressing.

On Jul 3, 2007, at 2:27 PM, Philippe Bossut wrote:

> Sheila Mooney wrote:
>> Once again, I am tasked with updating these files for Preview. I  
>> wanted to see if people thought we should simply keep this brief  
>> (like we have before) or consider adding more content in this file  
>> ie: description of product features and perhaps copying some  
>> content from the landing page in case people don't have internet  
>> access and can't get at the link. If we were to provide more info,  
>> what else should we consider putting in this file?
>
> I vote to keep it real short as we did in the past. All a README  
> should have is info to bootstrap a user from a downloaded bundle to  
> a running app. i.e., how to install and how to run first time.  
> Having pointers for more info (to the site) is good. Avoiding  
> duplicating info will avoid inconsistency and production headaches.  
> The only thing I would add is a reminder to open the Relnote file  
> for futher last minute information (known bugs mostly) and a  
> pointer to the license file.
>
> Cheers,
> - Philippe
> _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
>
> Open Source Applications Foundation "chandler-dev" mailing list
> http://lists.osafoundation.org/mailman/listinfo/chandler-dev



More information about the chandler-dev mailing list