generate readme from manpage

README.md

@@ -1,52 +0,0 @@
-track ![calver](https://img.shields.io/badge/calver-2018.05.29-22bfda.svg?style=flat-square) ![status](https://img.shields.io/badge/status-working-green.svg?style=flat-square) ![license](https://img.shields.io/badge/license-GPL3-blue.svg?style=flat-square)
-------
-
-**track** is a minimalistic data manager for the shell.
-
-Using the command line, track allows you to enter one and only one data point
-on any metric per day. It's great for tracking your weight or how many cups of
-coffee you drank. Track logs your data for each given metric to a CSV file. If
-you track the same metric twice in the same day, the data is updated. There's
-a few handy options for printing out the list data in useful formats as well.
-
-### Install
-
-`sudo make install`
-
-_Note: On systems without admin access the binary can be run directly from the
-git repo, but will lack `man` support and command completion._
-
-### Uninstall
-
-`sudo make uninstall`
-
-## Usage
-
-```bash
-track [options] [metric] [value]
-
-DIRECTORY:
-  If the environment variable $TRACK_DIR is set, track will store all data in
-  that location. Otherwise the default is the current working directory.
-
-USAGE:
-  track weight 150            Log 150lbs for today's weight
-  track -n 10 calories        Show last 10 days calorie values
-  track mood                  Show last value logged for mood
-
-OPTIONS:
-  -a                          Show all values of metric
-  -n N                        Show N values of metric
-  -x                          Remove metric file
-  -h                          Show this help
-  -v                          Show current version info
-  -d                          Debug mode
-```
-
-## Contributing
-
-Pull requests are welcome. For major changes, please open an issue first to
-discuss what you would like to change.
-
-## License
-[GPL3](LICENSE)

README.txt

@@ -0,0 +1,63 @@
+TRACK(1)                   General Commands Manual                   TRACK(1)
+
+NAME
+       track - a minimalistic data tracker
+
+SYNOPSIS
+       track [options] <metric> [<value>]
+
+DESRIPTION
+       Using  the  command  line,  track allows you to enter one and only one
+       data point on any metric per day. It's great for tracking your  weight
+       or  how  many cups of coffee you drank.  track logs your data for each
+       given metric to a CSV file. If you track the same metric twice in  the
+       same day, the data is updated. Data need not be numeric.
+
+OPTIONS
+       Setting  the  $TRACK_DIR  environment variable will change the default
+       location where the data is stored.  If it is not set the  current  di‐
+       rectory is used.
+
+       -a     Show all values of a metric
+
+       -n <N> Show N values of a metric
+
+       -x <metric>
+              Remove metric file
+
+       -c     Output in CSV format
+
+       -l     List all metrics being tracked
+
+       -h     Show the help.
+
+       -v     Display current version information.
+
+       -d     Debug mode.
+
+EXAMPLES
+       track weight 150
+              Log 150lbs for today's weight
+
+       track -n 10 calories
+              Show last 10 days calorie values
+
+       track mood `tired and hungry'
+              Show last value logged for mood
+
+       track mood
+              Show last value logged for mood
+
+LICENSE
+       GNU General Public License v3.0 or later at
+
+       https://www.gnu.org/licenses/gpl-3.0-standalone.html
+
+BUGS
+       Report  issues  at  the git repository at https://github.com/jamestom‐
+       asino/track
+
+AUTHOR
+       James Tomasino <james (at) tomasino (dot) org>
+
+v2020.10.11                      11 Oct 2020                         TRACK(1)