I'm trying to organise the documentation for the release of Tracks 1.5. So far, I've updated the installation instructions in /doc. There's a manual in HTML and PDF format, both generated automatically using multimarkdown from manual.tex. That directory also includes a changelog for Tracks, and a readme file - README_FOR_APP. Currently, that file duplicates what is now in the manual, so I'm proposing to move a very cut-down readme to the root of the tracks directory to point people to the /doc directory for the installation manual and changelog.
In the root directory, we also have: * CHANGELOG (for Rails, but seemingly very outdated) * CHANGELOG_TRACKS which points to the real changelog in /doc * README_DEVELOPERS (info on SQLite3 for testing and selenium) * README_RAILS (general info on Rails) * installation.html (the old installation instructions) This all seems a bit confusing and disorganising, so what I'm proposing is this: * 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. cheers, bsag -- but she's a girl - the weblog of a female geek http://www.rousette.org.uk [EMAIL PROTECTED] _______________________________________________ Tracks-discuss mailing list [email protected] http://lists.rousette.org.uk/mailman/listinfo/tracks-discuss
