Browse Source

Added INSTALL.md and related images, with mention in README.md

master
Trey Blancher 9 months ago
parent
commit
8c5c7282e3
7 changed files with 51 additions and 0 deletions
  1. +47
    -0
      INSTALL.md
  2. +4
    -0
      README.md
  3. BIN
      images/KM_icon.png
  4. BIN
      images/change_trigger.png
  5. BIN
      images/conflict_dialog.png
  6. BIN
      images/enable_macros.png
  7. BIN
      images/import_menu.png

+ 47
- 0
INSTALL.md View File

@ -0,0 +1,47 @@
# timetracker INSTALLATION
There are some things that you need to do in order to use timetracker like a pro. Here are the basics:
1. Install Keyboard Maestro from the MSC. If it is not available to you, send a helpdesk request to helpdesk@pindrop.com to request it. Install it using the standard MSC method.
1. Launch Keyboard Maestro. Two pieces should launch, the Editor and the Engine. If the Engine is loaded you should see the ![Keyboard Maestro icon][KM_icon] in your toolbar.
1. In the Keyboard Maestro Editor, select ![File/Import Macros Safely...][import_menu]. Import the `timetracker.kmmacros` file into Keyboard Maestro. All imported macros will be disabled by default.
1. Enable the "Insert Timestamp Begin" and "Insert Timestamp End" macros: ![Begin/End][enable_macros]. To select multiple macros hold down the "Command" ('⌘') and click each desired macro. Then click "Enable or Disable Macro" at the bottom of the Keyboard Maestro Editor window, in the center pane under "Macros".
a. If desired, you can modify the trigger for these macros at this time: ![Change Trigger][change_trigger]. You'll have to do this for each macro individually.
a. As imported, the Begin and End macros are triggered by: ⌘+Shift+D
1. You can repeat the above process for the "Insert Date (ISO 8601 format)" macro, which will allow you to quickly type out today's date in ISO-8601 date standard formate (e.g., "2020-04-07").
1. Now that you have the basic Begin and End macros imported and enabled, you can begin using them. In your favorite terminal emulator (e.g. iTerm2 or Terminal.app), open vim on today's log file:
```
cd ~/timetracker
vim 2020-04-07.log
```
Or, if you prefer, use gvim or Mac vim GUI programs.
1. If you haven't already, copy the .vimrc file from the timetracker GitHub repository to your home directory (`/Users/<username>/`, or `~/`). If you already have a .vimrc file that has your own customizations in it, consider adding the following line to your .vimrc:
```
nmap Y y$
```
If you do not do this you will have to modify the vim macro (see below).
1. The Keyboard Maestro macros make use of the `@a` vim macro. To record it in vim:
a. Press `q`, then release, and then type `a`. You should now see `recording @a` in the vim status line at the bottom of your vim window.
a. Press Escape (`Esc`) to go into normal/command vim mode (where you can navigate with `hjkl` keys).
a. If you are using the timetracker .vimrc, or have made the suggested edit to your own .vimrc, type the following keys:
```
klYjp
```
i. If you are not using the timetracker .vimrc, and have not made the suggested edit to your own .vimrc, type the following commands instead:
```
kly$jp
```
a. Press `q` again to stop recording the macro.
a. Trigger the vim macro by typing `@a` (the "Insert Timestamp End" macro does this automatically)
What these vim macros do is copy the category and task name from the above line (should be a Begin task), and paste it to the end of the End line. This should eliminate any mistakes when setting the end time of a task. Note that if a mistake is made on the Begin line, that mistake will be propagated to the End line when the "Insert Timestampt End" macro is executed.
1. Both the "Insert Timestamp Begin" and "Insert Timestamp End" macros automatically press the Escape key (`Esc`), so you can trigger them from normal/command mode, or insert mode. In vim, trigger the "Insert Timestamp Begin" macro by typing `⌘+Shift+D`, then `B` (or whatever you changed the trigger to be). If you haven't changed the trigger, a ![Conflict Dialog][conflict_dialog] will pop up, where you can choose the desired macro (either with your mouse, or by typing `B` for Begin, or `E` for End).
1. If you have chosen the "Insert Timestamp Begin" macro, you can type a category (`[In Square Brackets]`), then the title of the task you are beginning. Note that the title is free form, but having square brackets in the title, outside of the category is untested. Any other characters should be valid.
1. When you're finished with the task, run the "Insert Timestamp End" macro. You should see the timestamp with the "End" keyword, and the category and title of the above Begin task copied verbatim. Then the macro will automatically print another Begin line, ready for the next task.
Reach out to me (Trey Blancher, tblancher@pindrop.com), if you have questions or problems with this procedure. Or better yet, file an issue under the timetracker repository on GitHub.
[KM_icon]: https://github.atl.pdrop.net/tblancher/timetracker/images/KM_icon.png
[import_menu]: https://github.atl.pdrop.net/tblancher/timetracker/images/import_menu.png
[enable_macros]: https://github.atl.pdrop.net/tblancher/timetracker/images/enable_macros.png
[change_trigger]: https://github.atl.pdrop.net/tblancher/timetracker/images/change_trigger.png
[conflict_dialog]: https://github.atl.pdrop.net/tblancher/timetracker/images/conflict_dialog.png

+ 4
- 0
README.md View File

@ -1,6 +1,10 @@
# timetracker
tblancher's CLI-based time tracking system (see demo videos of the [timetracker setup](https://pindrop.zoom.us/rec/share/wvN6FoPfyEhJfo3x12qFVKofHL30X6a81Sce__IJmEp90tBtwdKHn7JnxZMQfz69) and [Clarizen process](https://pindrop.zoom.us/rec/share/yuF4C7_7rFlJAYnAq2TwarETAorMeaa8gXQdqfUPnRsgkXJf9_ByKUpI8hnGW1Jp))
## INSTALLATION
See [INSTALLATION.md](INSTALLATION.md) in this repository.
## OVERVIEW
This framework is what I use to keep track of my time, as I work. Only one task is allowed concurrently, so if I switch to another task, I must end the current task before proceeding. This is tracked in a log file with the following format:
## log file format


BIN
images/KM_icon.png View File

Before After
Width: 295  |  Height: 146  |  Size: 19 KiB

BIN
images/change_trigger.png View File

Before After
Width: 2864  |  Height: 1550  |  Size: 579 KiB

BIN
images/conflict_dialog.png View File

Before After
Width: 553  |  Height: 395  |  Size: 16 KiB

BIN
images/enable_macros.png View File

Before After
Width: 1686  |  Height: 1856  |  Size: 412 KiB

BIN
images/import_menu.png View File

Before After
Width: 848  |  Height: 976  |  Size: 674 KiB

Loading…
Cancel
Save