Skip to content

Commit e5baafc

Browse files
committed
README updates
1 parent 008b5d0 commit e5baafc

1 file changed

Lines changed: 13 additions & 2 deletions

File tree

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,13 @@ Installing GTM is a two step process. First, it's recommended you install the G
1515
- **Vundle** `Plugin 'git-time-metric/gtm-vim-plugin'`
1616
- **Pathogen** `git clone https://github.com/git-time-metric/gtm ~/.vim/bundle/gtm`
1717

18+
**Note** - to enable time tracking for a Git repository, you need to initialize it with `gtm init` otherwise it will be ignored by GTM. This is done via the command line.
19+
```
20+
> cd /path/to/your/project
21+
> gtm init
22+
23+
```
24+
1825
# Features
1926

2027
### Status Bar
@@ -46,11 +53,11 @@ endfunction
4653
autocmd User AirlineAfterInit call AirlineInit()
4754
```
4855

49-
*Note* - the time shown is based on the file's path and the Git repository it belongs to. You can have several files open that belong to different Git repositories. The status bar will display the time for the current file's Git repository. Also keep in mind, a Git repository must be initialized for time tracking in order to track time.
56+
**Note** - the time shown is based on the file's path and the Git repository it belongs to. You can have several files open that belong to different Git repositories. The status bar will display the time for the current file's Git repository. Also keep in mind, a Git repository must be initialized for time tracking in order to track time.
5057

5158
Consult the [README](https://github.com/git-time-metric/gtm/blob/master/README.md) and [Wiki](https://github.com/git-time-metric/gtm/wiki) for more information.
5259

53-
### Command Line Inteface
60+
### Command Line Interface
5461

5562
Use the command line to report on time logged for your commits.
5663

@@ -100,4 +107,8 @@ Tue Jun 28 ** 1h 36m 0s
100107
6h 58m 0s
101108
```
102109

110+
# Support
111+
112+
To report a bug, please submit an issue on the [GitHub Page](https://github.com/git-time-metric/gtm-vim-plugin/issues)
113+
103114
Consult the [README](https://github.com/git-time-metric/gtm/blob/master/README.md) and [Wiki](https://github.com/git-time-metric/gtm/wiki) for more information.

0 commit comments

Comments
 (0)