Andreas/tracks
1
0
Fork 0
mirror of https://github.com/TracksApp/tracks.git synced 2025-12-17 15:50:13 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

A few more edits to the documentation.

Browse source 
git-svn-id: http://www.rousette.org.uk/svn/tracks-repos/trunk@103 a4c988fc-2ded-0310-b66e-134b36920a42
This commit is contained in:
bsag 2005-06-11 13:52:15 +00:00
parent b4d72cf17a
commit 6c44e5231b
2 changed files with 6 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

7
tracks/README_FIRST.txt
View file

@ -1,6 +1,9 @@
The main README.txt file is in tracks/doc/README.txt, and the change log in tracks/doc/CHANGENOTES.txt. The main README file is in tracks/doc/README_FOR_APP, and the change log in tracks/doc/CHANGELOG. If you downloaded this application as a *.zip file, then there is documentation for the app in tracks/doc/app. If you open the index.html file in a browser, you can view the documentation for the methods, as well as viewing README_FOR_APP and CHANGELOG in more attractive format. If you checked out the application with Subversion, you need to generate the documentation. Navigate inside the tracks directory in a terminal, then issue the following command:
rake appdoc
This will generate the documentation as above in tracks/doc/app.
The database structure dump file (with some test contents) is in tracks/db/tracks_dump 03.01.2005.sql, which you can import into your database. Database schemas for MySQL, PostgreSQL and SQLite are available in tracks/db, along with some example contents in tracks_1.0.3_content.sql.
** IMPORTANT ** ** IMPORTANT **

2
tracks/doc/README_FOR_APP
View file

@ -48,7 +48,7 @@ In the following, I'm assuming that you're using MySQL and the built-in WEBrick
=== Upgrading from a previous version of Tracks === Upgrading from a previous version of Tracks
* Before you do anything else, <b>BACK UP YOUR DATABASE</b> (tables and content). Then make a separate export of the contents only (assuming that you want to move your data to the new version.) * Before you do anything else, <b>BACK UP YOUR DATABASE</b> (tables and content). Then make a separate export of the contents only (assuming that you want to move your data to the new version.)
* There are new fields in the projects and contexts table, so you might need to edit your contents dump accordingly. Use <tt>db/tracks_1.0.3_content.sql</tt> as a guide. If you were using Tracks 1.02a, you shouldn't need to edit either the users or todos table, but check <tt>db/tracks_1.0.3_content.sql</tt> if you are unsure. If you are upgrading from an earlier version of Tracks, it would be safer not to include the contents of your previous users table, but to create your users again through <tt>/signup</tt>. * There are new fields in the projects and contexts table, so you might need to edit your contents dump accordingly. Use <tt>db/tracks_1.0.3_content.sql</tt> as a guide for the correct syntax. In particular, note that you will need to manually add values to the position columns in projects and contexts. If you import your old database dump into the new database schema, all rows will get the position value of 0, which will break positioning. Add values from 1 upwards to each row. Don't worry about the order, as you can alter it through Tracks itself later. If you were using Tracks 1.02a, you shouldn't need to edit either the users or todos table, but check <tt>db/tracks_1.0.3_content.sql</tt> if you are unsure. If you are upgrading from an earlier version of Tracks, it would be safer not to include the contents of your previous users table, but to create your users again through <tt>/signup</tt>.
* For safety, rename your current Tracks directory to 'tracks-old' or something similar, and if you are able, create a new database for the new version. If you can't create a new database, delete the contents and tables in your old one MAKING SURE THAT YOU HAVE BACKED UP YOUR DATABASE FIRST. * For safety, rename your current Tracks directory to 'tracks-old' or something similar, and if you are able, create a new database for the new version. If you can't create a new database, delete the contents and tables in your old one MAKING SURE THAT YOU HAVE BACKED UP YOUR DATABASE FIRST.
* Import <tt>tracks_1.0.3_mysql.sql</tt> from <tt>tracks/db</tt> (or the appropriate schema for your database), then your own contents dump file into the new database. * Import <tt>tracks_1.0.3_mysql.sql</tt> from <tt>tracks/db</tt> (or the appropriate schema for your database), then your own contents dump file into the new database.
* Copy the files <tt>tracks/config/database.yml.tmpl</tt> and <tt>tracks/config/settings.yml.tmpl</tt> to the same file names without the <tt>*.tmpl</tt> extension (i.e. the extension should just be <tt>.yml</tt>). * Copy the files <tt>tracks/config/database.yml.tmpl</tt> and <tt>tracks/config/settings.yml.tmpl</tt> to the same file names without the <tt>*.tmpl</tt> extension (i.e. the extension should just be <tt>.yml</tt>).