Merge pull request #71 from dvklopfenstein/dox

Add `--upgrade` to `pip install` directions

Author: dvklopfenstein

doc/mkdocs/source/README.md

@@ -84,7 +84,7 @@ $ trk hours
 ## Installation
 Install with [timetracker-csv](https://pypi.org/project/timetracker-csv/) pip:
 ```
-$ pip install timetracker-csv
+$ pip install --upgrade timetracker-csv
 ```
 Or install from source:
 ```

doc/mkdocs/source/index.md

@@ -50,6 +50,8 @@ The project repository (repo) name is "meetinghouse."
 $ cd /home/bez/projs/meetinghouse
 
 $ trk init --csvdir doc/
+or
+$ trk init --d doc/
 Initialized timetracker directory: /home/bez/projs/meetinghouse/.timetracker
 
 #----------------------------------------------------
@@ -58,7 +60,8 @@ $ trk start
 Timetracker started now: Mon 09:00 AM: 2025-03-24 09:00:00
 ```
 
-Initializing with the option `--csvdir doc/` will cause time units to be written to
+Initializing with the option `--csvdir doc/` (`-d doc/`)
+will cause time units to be written to
 a csv file stored in the `doc/` directory,
 rather than in the default repo root directory.
 ```sh
@@ -83,7 +86,7 @@ $ trk hours
 ## Installation
 Install with [timetracker-csv](https://pypi.org/project/timetracker-csv/) pip:
 ```sh
-$ pip install timetracker-csv
+$ pip install --upgrade timetracker-csv
 ```
 Or install from source:
 ```sh

doc/mkdocs/source/installation.md

@@ -8,7 +8,7 @@ License: https://www.gnu.org/licenses/agpl-3.0.en.html#license-text
 ## Installation
 Install with [timetracker-csv](https://pypi.org/project/timetracker-csv/) pip:
 ```sh
-$ pip install timetracker-csv
+$ pip install --upgrade timetracker-csv
 ```
 Or install from source:
 ```sh

doc/mkdocs/source/usage_basic.md

@@ -29,15 +29,15 @@ Comma-separated value
 files store tabular data in plain text.
 CSV files are readable by both humans and computers.
 Each time unit is stored in a single row.
-Each row contains several columns, including:
-
-Name              | Example
-------------------|-----------------------------
-Start time        | 9am Monday, March 31, 2025
-Duration          | 2 hours
-One activity type | "documenting" or "coding"
-Description       | Made decorative almond tree blossoms out of gold
-Tags              | grant=ABC, grant=XYZ, art, metalwork
+Each row contains five columns:
+
+Name              | Required | Example
+------------------|----------|------------------
+Start time        | required | 9am Monday, March 31, 2025
+Duration          | required | 2 hours
+One activity type | optional | "documenting" or "coding"
+Description       | required | Made decorative almond tree blossoms out of gold
+Tags              | optional | grant=ABC, grant=XYZ, art, metalwork
 
 There can be one activity per time unit.