On 28 Jan 2008, at 8:16, Reinier Balt wrote:

>>
>> * Delete /installation.html (duplicated by new manual.html)
>> * Delete /CHANGELOG
>> * Add /README_FIRST to point users to /doc directory for
>> manual and changelog
>> * Delete CHANGELOG_TRACKS (see point above)
>> * Move README_DEVELOPERS to /doc
>> * Move README_RAILS to /vendor/rails and include a link
>> pointing to it in README_FIRST for those wanting more general
>> information about Rails
>>
>> What do people think? Also, if anyone has a few minutes to
>> look through the new manual, please do, and let me know if
>> you find any errors or things that need adding.
>>
>
> I think this cleanup would great.
> I guess that if README_RAILS is old, we should just remove it
> or replace it with a current one.

I've made the changes I suggested in [704]. I left README_RAILS in / 
vendor/rails, because it's quite generic, but potentially useful  
information about Rails. Hidden away in /vendor, it shouldn't confuse  
non-technical users ;-)

> I think the installation manual is very complete. It remains
> rather technical though so perhaps we could consider including
> some sort of upgrade script or something for future releases?

I think an update script would be a great idea if we could make it  
sufficiently reliable and able to cope with a range of situations.

I'm probably not the best person to write the documentation, given  
that I'm fairly technical myself, and know the system quite well!  
However, it's mostly complex because of the range of platforms and  
configurations involved, and most users shouldn't have to read the  
whole manual. I've noted something to that effect in README_FIRST.  
Perhaps I should also write 'DON'T PANIC' in large and friendly  
letters on the cover, like the Hitchhiker's Guide to the Galaxy?

I'm also hoping to pre-configure the stable zipped release for use  
with Locomotive for Mac OS X users, and get help from Windows users to  
do something similar for Windows users (any volunteers?). Then I can  
have a section at the beginning of the manual, which amounts to an  
'easy' installation for non-technical users who just want to run  
Tracks on their own Mac or PC.

Thanks,

Jackie

--
Dr. Jackie Chappell
Lecturer in Animal Behaviour
Centre for Ornithology
School of Biosciences
University of Birmingham, B15 2TT, UK
Email: [EMAIL PROTECTED]
Web: http://www.ornithology.bham.ac.uk/academicstaff.htm#Dr_Jackie_Chappell
Tel: 0121 414 3257, Fax: 0121 414 5925

_______________________________________________
Tracks-discuss mailing list
[email protected]
http://lists.rousette.org.uk/mailman/listinfo/tracks-discuss

Reply via email to