Location: PHPKode > projects > Run > Run-0.8.0.2/README.txt
---------------------------------
Run
---------------------------------

Run is an application that replaces the old fashioned paper diary where runners log details of their running activities. From the very beginning of development planning to the current version, Run is being developed with runners' needs in mind and it was extensively tested by real runners. With Run runners can keep track of dates of their runs, what time of day they ran, how long was their run, distance covered, type of run, surface and terrain they ran on, weather information such as meteorological occurrences and temperature, average heart rate during the run, their weight, how they felt and additional personal notes.

But, besides just replacing paper based diary, Run's functionality includes automatizations of certain tasks that otherwise have to be carried out manually (or cannot be carried out manually without much difficulties). Such functions in the current version of Run include:
- tracking current and past distance covered in a given month/year,
- amount of time spent on the runs,
- tracking shoe usage that helps prevent unnecessary injuries,
- pace calculator that calculates speed in km/h and min/km for the desired distance when either total time and distance or per kilometer time and distance are provided,
- native support for tracking data for multiple runners with username/password access, and
- running shoe management tool for each user with capability of adding, retiring, re-activating shoes, and easily tracking milage per shoe.

Current functionality of Run will be enhanced even further in future versions that will among many other functions include:
- interactive visualization of numerical data (various comparisons that help runners maximize their training and racing potentials and above all help them avoid most common injuries),
- route planning tools (interactive maps and distance measuring tools),
- hours slept and morning pulse data,
- injury and illness reporting,
- various statistical correlation calculations (to find out what makes or breaks a runner),
- run data displayed in a calendar week/month mode,
- group training overview for coaches of running teams,
- running plans for various distances, and
- running tips.

At the current stage, Run is developed entirely with PHP and JavaScript programming languages, uses MySQL database, and HTML and CSS for formatting. However, for new features other programming languages, libraries and technologies will be used. For example, graphical visualization of data will most likely be built with Perl and its graphic modules, and route maps support will most likely be developed with Processing or SVG.

You can get the latest version of Run on Run project site: http://run.sourceforge.net

Licence: Run is released under GPL. You can find a copy of GPL license in /License-GPL.txt.
Version: 0.8.0.2
Release date: 18.5.2005


--------------------------------
Run 0.8.0.2 Highlights
--------------------------------

Run 0.8.0.2 is actually the same as 0.8 and 0.8.0.1. The only difference between these versions are a few bug fixes.

--------------------------------
Run 0.8 Highlights
--------------------------------

Run 0.8 is the first major Run release in almost 6 months. It presents the culmination of ideas that have been brewing in the RunLab during the last several months. Changes and improvements since tha last release are numerous, so only the most important will be mentioned here (for a full list of changes check out the changelog).

Probably the most important change is introduction of runner administration. This brings along a lot of changes in the way Run is used. I believe that many users who host their own pages wanted to offer Run to their friends or family, or even as an added value to their site. With this release of Run, openning your installation of Run for others in a safe way is now possible. Which means that user authorization has been greatly improved and that concept of user maintenance has changed too. Run 0.8 includes a separate runner administration interface for adding, changing and accessing data about your runners. Also, each runner can change selected personal data, passwords, measurement units ... more on that later.

Another great improvement is the addition of different measurement units. Runners from countries where non-metric system is in use can now enter information about your runs in units you are used to: distance in either kilometers or miles, temperature in either Celsius or Fahrenheit, and weight in either kilograms, pounds or stones. Hopefully many of you will appreciate that, since you won't have to convert that information anymore. This change is application wide and thus includes shoe management, pace and splits calculators and so on.

Main display has also changed and you can now choose between two different view modes: you can view your running data in either summarized mode where only selected columns are displayed, or in full view mode where all data is displayed. Also the way data is presented in the main display window has changed a bit and now rows are displayed in alternately changing colors for easier viewing (this feature was requested by Rogier, and made me think about it ... so thanks Rogier).

Users can now change their personal data and Run settings: measurement units, view mode, and password access.

As always, there have been even more application-wide changes that are "behind the scenes" and are thus not immediately noticable to the user, but do contribute to streamlined functioning of Run. To explore the details of all changes that make the 0.8 version of Run a version that rocks, see the Run Change Log.

To find out more about how to upgrade from your older version of Run to 0.8 please see, Upgrading Run (http://run.sourceforge.net/manual/upgrading.php).

I hope that all these improvements are important contribution to the overall user satisfaction. Drop me a note if you have a question or a suggestion for further improvements, or if you have any trouble setting up Run. I'll help in any way I can.

You can get your copy of Run 0.8 at the following location: http://prdownloads.sourceforge.net/run/Run-0.8.tar.gz?download.

For complete list of changes featured in this version of Run, see http://run.sourceforge.net/download/change.php.

--------------------------------
Installing, Configuring and Using Run
--------------------------------

To install Run follow these steps:
0. Open file Run-0.8/system/configuration.php and edit the neccessary information.
1. Copy contents of Run-0.8 directory into a directory that is accessible with your browser.
2. Point your browser to the file Install/CleanInstall08.php.
3. Begin using Run.

You can find complete documentation on how to set up and use Run on the Run home page. Point your browser at http://run.sourceforge.net and navigate to How to Use Run.

--------------------------------
Upgrading Run
--------------------------------

In this section you will find all the neccessary information if you are already using Run and just want to upgrade to a newer version.

--------------------------------
Upgrading from 0.8.0.1 to 0.8.0.2

To upgrade from Run 0.8.0.1 to Run 0.8.0.2 you only have to copy files from the directory Run-0.8.0.2 into the directory from which you are currently using Run.

--------------------------------
Upgrading from 0.8 to 0.8.0.1

To upgrade from 0.8 to 0.8.0.1, you can copy just display.php file to an already existing Run location on your server.
--------------------------------
Upgrading from 0.7.3 to 0.8

To upgrade from Run 0.7.3 to Run 0.8 you have to copy files from the directory Run-0.8 into the directory from which you are currently using Run. Make sure you keep your old system/configuration.php file.

After you have copied those files point your browser to Install/Upgrade073-08.php. This is a script that will restructure your old Run database so that it will conform with the new functionallity.

--------------------------------
Upgrading from 0.7.2 to 0.7.3

To upgrade from Run 0.7.2 to Run 0.7.3 you have to copy files from the directory Run-0.7.3 into the directory from which you are currently using Run.

Since there has been a minor change in the table structure where data about shoes are stored, execute a php script that will do the job for you. For your convenience the script is located in the following folder [your Run directory]/mysql/MysqlUpdates073.php. Open this location in your browser and if you see a message "Tables have been successfully updated. You can now remove this file." it means that everything went smoothly and it is recommended that you delete this script (along with the directory).

--------------------------------
Upgrading from 0.7.1 to 0.7.2

To upgrade from Run 0.7.1 to Run 0.7.2 you only have to copy files from the directory Run-0.7.2 into the directory from which you are currently using Run.

--------------------------------
Upgrading from 0.7 to 0.7.1

To upgrade from Run 0.7 to Run 0.7.1 you only have to copy files from the directory Run-0.7.1 into the directory from which you are currently using Run.

--------------------------------
Upgrading from 0.6.1 to 0.7

Quite a few major functionality changes have been made between versions 0.6.1 and 0.7. Besides copying files from the directory Run-0.7 into the directory form which you are currently using Run, you will also have to create a new table in the Run database that is used for Shoe Management functionality in Run.

Here's the extract from the <a href="">Installing and configuring Run</a> section of this manual describing how to create the table for managing shoes in Run:

Shoe management table. Next you will have to create a table for the Run Shoe management functionality. This is the table where shoe usage information for all users is stored, so you do not have to create a new table for each runner - one such table is sufficient. MySQL table description for shoe management is outlined in a file "Createshoestable" in Install directory (Install/Createshoetable). To create table where shoes information will be stored, run the following command from the command line (again assuming that you are in the Install directory):

mysql Run < Createshoestable

NOTE: The default name of this table is Shoes. Although you can name this table as you like it, it is recommended that you leave the name at its default value. If you decide to change the name of this table, you will have to change the configuration file accordingly. For more information see second step (Configure Run) of section <a href="">Installing and configuring Run</a>.


--------------------------------
Using Run
--------------------------------

Run being a web based application has at least two major advantages: (1) it is easy to set up an environment for more than one user, and more important (2) it runs in a web browser that practically any computer today has installed and on top of that almost everyone is familiar with web-like interfaces. The latter reason makes Run an application that takes practically no time to learn how to use. However, there are several conventions behind the interface which should be explained. Another point that should be stressed here is that although a lot of people are running, not everyone is familiar with the terminology that is associated with running.

Run does not include any obscure terms, so most things are self-explenatory, but whenever you bump into something you do not understand, you can consult this part of the Run manual to find out what it means or why is it good to keep track of something.

--------------------------------
First time users
If you are using Run for the first time, you might find this information helpful. To access Run, open a browser of your choice and in the address bar type the address where either you have set up Run or the address of the server where Run is located. For example, you could have run at the following address: http://www.anydomain.org/run.

Now depending on the site-specific Run setup, two different things might show up:
1. If you have set up user authentication (.htaccess - for more details Configure authentication in Run and on your web server section of the Installing and configuring Run), a pop-up window will ask you for your username and password combination to enter Run. Enter your username and password to proceed. If you entered the correct combination, you will be taken to the main display window in Run that shows your data for the current month.
2. If you haven't configured user authentication (.htaccess), you will see the front page (Login screen) for Run.

When using Run for the first time, you will have to log in to Run administration with the following default data:
username: Administrator
password: admin
Once logged in, the first thing you should do is change the Administrator's password from its default value. To do this, click Settings link in the navigation and a pop-up window will open where you will be asked to enter the new password.

After you have changed the default password, you will have to create runners' accounts. To do so click Add New Runner link in the navigation and enter all information to create a new runner. Once you have created at least one runner, you or that runner can start using Run.

For more information on how to use Run, please see the documentation located on the Run website.

--------------------------------
Shortcuts in Run
Majority of Run's functionality and options are accessible through keyboard shortcuts that will provide both comfortable use and speed up your navigation through Run. There are some general shortcuts that are the same throughout Run, and some that are used only for specific functionality.

General shortcuts:
- Submit - Alt+S - submit the data in the form to the database.
- Wipe - Alt+W - clear all the data from the form.
- Close - Alt+C - close the window.

Specific shortcuts:
- Log a Run - Alt+L - open a form to log your run from the main display window.
- Pace Calculator - Alt+P - open the Pace Calculator from the main display window.
-- Calculate Pace - Alt+P - use this shortcut to calculate the pace and speed after providing total time and distance of a run to the Pace Calculator.
-- Calculate Time - Alt+T - use this shortcut to calculate the goal time and speed after providing pace per kilometer and distance of a run to the Pace Calculator.
- Shoe Management - Alt+S - open the Shoe Management from the main display window.
-- View Active Shoes - Alt+A - view all your active shoes in the Shoe Management.
-- View Retired Shoes - Alt+R - view all your retired shoes in the Shoe Management.
-- Add New Shoe - Alt+N - add a new shoe in the Shoe Management.
- Refresh - Alt+R - refresh data display of the main display window.
- Logout - Alt+Q - logout from Run.
- Display - Alt+D - after selecting the time period and shoes you used during that period, use this shortcut to view desired data.

TIP: You do not have to memorize all of the shortcuts as you will be reminded of the correct key combinations by (1) pop-up notifications when you position your mouse over a link and (2) by underlined letters in words of links which provide hints to which letter use with the Alt key to access desired functionality, except for the shortcuts associated with the form buttons such as are "Submit", "Wipe" and "Display".


---------------------------------
Problems & Questions
---------------------------------

If you encounter any difficulties or problems, or have just about any kind of question regarding Run, feel free to contact me directly at hide@address.com Alternatively you can also post your question, problem, or comment on the Run forum accessible via Run Project page on SourceForge.net.


---------------------------------
Author & License
---------------------------------

Run is written and maintained by Mladen Zagorac - hide@address.com

Run is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 2 as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details, in License-GPL.txt file.
Return current item: Run