Fixed formatting and minor adjustments

This commit is contained in:
tblancher 2020-04-07 18:56:17 -04:00 committed by GitHub Enterprise
parent 30123f2a38
commit 9c50996b06
1 changed files with 14 additions and 14 deletions

View File

@ -1,4 +1,4 @@
# timetracker INSTALLATION
# timetracker INSTALL
There are some things that you need to do in order to use timetracker like a pro. Here are the basics:
@ -15,26 +15,26 @@ 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:
6. 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:
7. 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:
```
klYjp
kly$jp
```
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)
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).
8. 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.