github.com/kilpkonn/gtm-enhanced@v1.3.5/README.md (about) 1 <div align="center"><img src="https://cloud.githubusercontent.com/assets/630550/19619834/43c460dc-9835-11e6-8652-1c8fff91cf02.png" alt="GTM Logo" height="115" width="275"></div> 2 <div align="center"><font size=16><bold>Git Time Metric</bold></font></div> 3 4 ### Seamless time tracking for all your Git projects 5 6 ##### $ gtm report -last-month 7 <div><img src="https://cloud.githubusercontent.com/assets/630550/21582250/8a03f9dc-d015-11e6-8f77-548ef7314bf7.png"></div> 8 9 ##### $ gtm report -last-month -format summary 10 <div><img src="https://cloud.githubusercontent.com/assets/630550/21582252/8f85b738-d015-11e6-8c70-beed7e7b3254.png"></div> 11 12 ##### $ gtm report -last-month -format timeline-hours 13 <div><img src="https://cloud.githubusercontent.com/assets/630550/21582253/91f6226e-d015-11e6-897c-6042111e6a6a.png"></div> </br> 14 15 GTM is automatic, seamless and lightweight. There is no need to remember to start and stop timers. It runs on occasion to capture activity triggered by your editor. The time metrics are stored locally with the git repository as [Git notes](https://git-scm.com/docs/git-notes) and can be pushed to the remote repository. 16 17 ### <div align="center">Plugins</div> 18 19 Simply install a plugin for your favorite editor and the GTM command line utility to start tracking your time now. 20 21 <p><img src="https://cloud.githubusercontent.com/assets/630550/17458557/72247454-5bda-11e6-84ce-03364b8ac832.png" width="64" height="64"> 22 <img src="https://cloud.githubusercontent.com/assets/630550/17458560/72397408-5bda-11e6-909c-c2dd2dad3b52.png" width="64" height="64"> 23 <img src="https://cloud.githubusercontent.com/assets/630550/17458562/7264e2be-5bda-11e6-8311-bbed672ffb8f.png" width="64" height="64"> 24 <img src="https://cloud.githubusercontent.com/assets/630550/17458559/72302916-5bda-11e6-886e-2a41f423b06f.png" width="64" height="64"> 25 <img src="https://cloud.githubusercontent.com/assets/630550/17458563/7264f06a-5bda-11e6-9fb6-d0469730c1cb.png" width="64" height="64"> 26 <img src="https://cloud.githubusercontent.com/assets/630550/17458556/72030a62-5bda-11e6-89e4-6a3921034aed.png" width="64" height="64"> 27 <img src="https://cloud.githubusercontent.com/assets/630550/17458564/727d43a4-5bda-11e6-8b3c-56d3fb7bf988.png" width="64" height="64"> 28 <img src="https://cloud.githubusercontent.com/assets/630550/17458555/71e4352e-5bda-11e6-89d3-e8ff2c3a86e2.png" width="64" height="64"> 29 <img src="https://cloud.githubusercontent.com/assets/630550/17458561/72417ac2-5bda-11e6-9769-04cffc64397e.png" width="64" height="64"> 30 <img src="https://cloud.githubusercontent.com/assets/630550/17458591/82e06c98-5bdb-11e6-8ae0-c5b2bd2fe97f.png" width="64" height="64"> 31 <img src="https://cloud.githubusercontent.com/assets/630550/17458558/72269342-5bda-11e6-8194-d9bf030bd037.png" width="64" height="64"> 32 <img src="https://cloud.githubusercontent.com/assets/630550/19619987/f9f7523a-9838-11e6-99da-c3fda05ce0d6.png" width="64" height="64"></p> 33 34 # Getting Started 35 36 ### Install the latest GTM release 37 38 **Mac OS X** 39 40 The simplest way to install is to use [Homebrew](http://brew.sh) 41 42 ``` 43 brew tap git-time-metric/gtm 44 brew install gtm 45 ``` 46 47 **Windows** 48 49 - Download and run the Windows installer from [here](https://github.com/git-time-metric/gtm/releases/latest) 50 51 **Linux** 52 53 The simplest way to install is to use [Linuxbrew](http://linuxbrew.sh/) 54 55 ``` 56 brew tap git-time-metric/gtm 57 brew install gtm 58 ``` 59 60 **Manually install for Linux, OSX or Windows** 61 62 - Download and install the executable from [here](https://github.com/git-time-metric/gtm/releases/latest) 63 64 65 ### Install a plugin for your editor 66 67 - [Sublime 3](https://github.com/git-time-metric/gtm-sublime3-plugin) 68 - [Atom](https://github.com/git-time-metric/gtm-atom-plugin) 69 - [Vim](https://github.com/git-time-metric/gtm-vim-plugin) 70 - [IntelliJ IDEA, PyCharm, WebStorm, AppCode, RubyMine, PhpStorm, AndroidStudio ](https://github.com/git-time-metric/gtm-jetbrains-plugin) 71 - [VSCode](https://github.com/nexus-uw/vscode-gtm) 72 - [Terminal](https://github.com/git-time-metric/gtm-terminal-plugin) 73 74 ### Initialize a project for time tracking 75 76 <pre>$ cd /my/project/dir 77 $ gtm init 78 79 Git Time Metric initialized for /my/project/dir 80 81 post-commit: gtm commit --yes 82 alias.fetchgtm: fetch origin refs/notes/gtm-data:refs/notes/gtm-data 83 alias.pushgtm: push origin refs/notes/gtm-data 84 notes.rewriteref: refs/notes/gtm-data 85 terminal: true 86 .gitignore: /.gtm/ 87 tags: tag1, tag2 </pre> 88 89 ### Edit some files in your project 90 91 Check your progress with `gtm status`. 92 93 <pre>$ gtm status 94 95 20m 40s 53% [m] plugin/gtm.vim 96 18m 5s 46% [r] Terminal 97 15s 1% [m] .gitignore 98 39m 0s <b>gtm-vim-plugin</b> </pre> 99 100 ### Commit your work 101 102 When you are ready, commit your work like you usually do. GTM will automatically save the time spent associated with your commit. To check the time of the last commit type `gtm report`. 103 <pre>$ gtm report 104 105 7129f00 <b>Remove post processing of status</b> 106 Fri Sep 09 20:45:03 2016 -0500 <b>gtm-vim-plugin</b> Michael Schenk 107 108 20m 40s 53% [m] plugin/gtm.vim 109 18m 5s 46% [r] Terminal 110 15s 1% [m] .gitignore 111 39m 0s <b>gtm-vim-plugin</b> </pre> 112 113 ### Optionally save time in the remote Git repository 114 115 GTM provides [git aliases](https://git-scm.com/book/en/v2/Git-Basics-Git-Aliases) to make this easy. It defaults to origin for the remote repository. 116 117 Time data can be saved to the remote repository by pushing. 118 <pre>$ git pushgtm </pre> 119 120 Time data can be retrieved from the remote repository by fetching. 121 <pre>$ git fetchgtm </pre> 122 123 ### Getting Help 124 125 For help from the command line type `gtm --help` and `gtm <subcommand> --help`. 126 127 For additional help please consult the [Wiki](https://github.com/git-time-metric/gtm/wiki). 128 129 # Contributing 130 [![Build Status](https://travis-ci.org/git-time-metric/gtm.svg?branch=develop)](https://travis-ci.org/git-time-metric/gtm) [![Build status](https://ci.appveyor.com/api/projects/status/gj6tvm8njgwj0hqi?svg=true)](https://ci.appveyor.com/project/mschenk42/gtm) [![Coverage Status](https://coveralls.io/repos/github/git-time-metric/gtm/badge.svg)](https://coveralls.io/github/git-time-metric/gtm) [![Go Report Card](https://goreportcard.com/badge/github.com/git-time-metric/gtm)](https://goreportcard.com/report/github.com/git-time-metric/gtm) [![Stories in Ready](https://badge.waffle.io/git-time-metric/gtm.png?label=ready&title=Ready)](https://waffle.io/git-time-metric/gtm) 131 132 If you find a bug or have an idea for a new feature please feel free to file new issues and submits PRs. In particular if there isn't a plugin for your favorite editor, go ahead and create one! 133 134 For more detail on how to write plugins, check out the [Wiki](https://github.com/git-time-metric/gtm/wiki/Editor-Plugins). 135 136 # Support 137 138 To report a bug, please submit an issue on the [GitHub Page](https://github.com/git-time-metric/gtm/issues) 139 140 Consult the [Wiki](https://github.com/git-time-metric/gtm/wiki) for more information.