71 lines
7.4 KiB
Markdown
71 lines
7.4 KiB
Markdown
# timetracker INSTALL
|
|
## Basic Installation
|
|
Use `git clone` to create a local copy of the timetracker repository on your local MacBook Pro. If you'd rather use the older, slower Python/Bash scripts, you can then copy or link the `timetracker.py`, `do_process.sh`, and `chug.sh` files into your path. I like to keep these in a `~/timetracker` directory, where I execute them with a leading `./` so they don't need to be in my `PATH` variable.
|
|
|
|
If you'd prefer to use the Rust programs (which is highly recommended, if only for execution speed), you will need to compile the Rust programs with `cargo` (the Rust language package manager). Do the following:
|
|
1. Install the `rust` package from Homebrew:
|
|
```
|
|
brew install rust
|
|
```
|
|
Homebrew may update itself before installing `rust`.
|
|
1. Navigate to the `timetracker/rust/timetracking` directory in the cloned `timetracker` source directory
|
|
1. Execute the following command:
|
|
```
|
|
cargo build --release
|
|
```
|
|
If you are intending to debug or otherwise develop the Rust programs, I recommend creating a fork on GitHub, making your proposed changes in your local clone of the fork, and then issue a PR against my parent repository. In that case you can drop the `--release` argument, which will keep debugging symbols and such in the executable.
|
|
1. The compiled executables will be in the `target/release` or the `target/debug` subdirectories, depending on whether you provided `--release` to the build step (without this flag the executables will be in the `debug` subdirectory). You may copy them or link them to your `PATH` (e.g., `~/bin`) for use.
|
|
- Note that if you're working on a specific program in the package, you can change directory to whichever executable you're working on (`chug`, `doprocess`, `timetracker`, or the library package `timelogging`), you will likely want to run the debug version directly, like so:
|
|
```
|
|
cargo run -- <input arguments>
|
|
```
|
|
## Pro Tips
|
|
There are some things that you need to do in order to use timetracker like a pro. These instructions assume you're using the vim or gvim (GUI) editor. There are likely similar macros you can enable for editors such as Atom or Sublime, but you'll have to review the documentation for those editors to be able to reproduce the ideas there.
|
|
|
|
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".
|
|
* 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.
|
|
* 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:
|
|
* 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.
|
|
* Press Escape (`Esc`) to go into normal/command vim mode (where you can navigate with `hjkl` keys).
|
|
* If you are using the timetracker .vimrc, or have made the suggested edit to your own .vimrc, type the following keys:
|
|
```
|
|
klYjp
|
|
```
|
|
* 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
|
|
```
|
|
* Press `q` again to stop recording the macro.
|
|
* 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.
|
|
- NOTE: If you use the Rust programs for digesting your logs, having multiple categories/strings inside square brackets will cause the Rust program to panic. The older Python/Bash scripts handle this a bit more gracefully at the time of this writing.
|
|
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/tree/master/images/KM_icon.png
|
|
[import_menu]: https://github.atl.pdrop.net/tblancher/timetracker/tree/master/images/import_menu.png
|
|
[enable_macros]: https://github.atl.pdrop.net/tblancher/timetracker/tree/master/images/enable_macros.png
|
|
[change_trigger]: https://github.atl.pdrop.net/tblancher/timetracker/tree/master/images/change_trigger.png
|
|
[conflict_dialog]: https://github.atl.pdrop.net/tblancher/timetracker/tree/master/images/conflict_dialog.png
|