|
12 | 12 |
|
13 | 13 | <br /> |
14 | 14 |
|
| 15 | +# Support GitLens |
| 16 | + |
| 17 | +While GitLens is generously offered to everyone free of charge, if you find it useful, please consider [**supporting**](https://gitlens.amod.io/#support-gitlens) it. |
| 18 | + |
| 19 | +- [**Become a Sponsor**](https://www.patreon.com/eamodio 'Become a sponsor on Patreon') — join the growing group of generous [backers](https://github.com/eamodio/vscode-gitlens/blob/master/BACKERS.md) |
| 20 | +- [**Donate via PayPal**](https://www.paypal.me/eamodio 'Donate via PayPal') or [**Donate via Cash App**](https://cash.me/$eamodio 'Donate via Cash App') |
| 21 | + |
| 22 | +Also please [write a review](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens#review-details 'Write a review'), [star or fork me on GitHub](https://github.com/eamodio/vscode-gitlens 'Star or fork me on GitHub'), and [follow me on Twitter](https://twitter.com/eamodio 'Follow me on Twitter') |
| 23 | + |
15 | 24 | # What's new in GitLens 9 |
16 | 25 |
|
17 | 26 | ## 9.0 — November 2018 |
@@ -55,60 +64,42 @@ See the [release notes](https://github.com/eamodio/vscode-gitlens/blob/master/CH |
55 | 64 | # GitLens |
56 | 65 |
|
57 | 66 | [GitLens](http://gitlens.amod.io 'Learn more about GitLens') is an [open-source](https://github.com/eamodio/vscode-gitlens 'Open GitLens on GitHub') extension for [Visual Studio Code](https://code.visualstudio.com) created by [Eric Amodio](http://www.amod.io 'Learn more about Eric'). |
58 | | -While GitLens is generously offered to everyone free of charge, if you find it useful please consider [supporting](#support-gitlens 'Support GitLens') it. ❤ |
59 | 67 |
|
60 | | -GitLens simply helps you better understand code. Quickly glimpse into whom, why, and when a line or code block was changed. Jump back through history to gain further insights as to how and why the code evolved. Explore the history and evolution of a codebase. |
| 68 | +GitLens simply helps you **better understand code**. Quickly glimpse into whom, why, and when a line or code block was changed. Jump back through history to **gain further insights** as to how and why the code evolved. Explore the history and evolution of a codebase. |
61 | 69 |
|
62 | | -Here are just some of the features that GitLens provides, |
| 70 | +While GitLens is **powerful and feature rich**, it is also [highly customizable](#gitlens-settings- 'Jump to the GitLens settings docs') to meet your specific needs — find code lens intrusive or the current line blame annotation distracting — no problem, it is quick and easy to turn them off or change how they behave via the built-in [_GitLens Settings_ editor](#configuration 'Jump to Configuration'), an **interactive editor** covering many of GitLens' powerful settings. While for more advanced customizations, refer to the [GitLens settings docs](#gitlens-settings- 'Jump to the GitLens settings docs') and edit your vscode [user settings](https://code.visualstudio.com/docs/getstarted/settings 'Open User settings'). |
63 | 71 |
|
64 | | -- an unobtrusive [current line blame](#current-line-blame- 'Jump to the Current Line Blame') annotation at the end of the line with detailed blame information accessible via [hovers](#hovers- 'Jump to Hovers') |
65 | | -- on-demand [gutter blame](#gutter-blame- 'Jump to the Gutter Blame') annotations, including a heatmap, for the whole file |
66 | | -- [authorship code lens](#code-lens- 'Jump to the Code Lens') showing the most recent commit and # of authors to the top of files and/or on code blocks |
67 | | -- on-demand [gutter heatmap](#gutter-heatmap- 'Jump to the Gutter Heatmap') annotations to show how recently lines were changed, relative to all the other changes in the file and to now (hot vs. cold) |
68 | | -- on-demand [recent changes](#recent-changes- 'Jump to the Recent Changes') annotations to highlight lines changed by the most recent commit |
69 | | -- a [status bar blame](#status-bar-blame- 'Jump to the Status Bar Blame') annotation showing author and date for the current line |
70 | | -- many rich Side Bar views |
71 | | - - a [_Repositories_ view](#repositories-view- 'Jump to the Repositories view') to visualize, navigate, and explore Git repositories |
72 | | - - a [_File History_ view](#file-history-view- 'Jump to the File History view') to visualize, navigate, and explore the revision history of the current file |
73 | | - - a [_Line History_ view](#line-history-view- 'Jump to the Line History view') to visualize, navigate, and explore the revision history of the selected lines of current file |
74 | | - - a [_Search Commits_ view](#search-commits-view- 'Jump to the Search Commits view') to search and explore commit histories by message, author, files, id, etc |
75 | | - - a [_Compare_ view](#compare-view- 'Jump to the Compare view') to visualize comparisons between branches, tags, commits, and more |
76 | | -- many [powerful commands](#navigate-and-explore- 'Jump to the Navigate and Explorer') for exploring commits and histories, comparing and navigating revisions, stash access, repository status, etc |
77 | | -- user-defined [modes](#modes- 'Jump to the Modes') for quickly toggling between sets of settings |
78 | | -- and so much [more](#and-more- 'Jump to More') |
| 72 | +Here are just some of the **features** that GitLens provides, |
79 | 73 |
|
80 | | -GitLens is powerful, feature rich, and also [highly customizable](#gitlens-settings- 'Jump to the GitLens settings docs') to meet your specific needs — find code lens intrusive or the current line blame annotation distracting — no problem, it is quick and easy to turn them off or change how they behave via the built-in [_GitLens Settings_ editor](#configuration 'Jump to Configuration'), an interactive editor covering many of GitLens' powerful settings. While for more advanced customizations, refer to the [GitLens settings docs](#gitlens-settings- 'Jump to the GitLens settings docs') and edit your vscode [user settings](https://code.visualstudio.com/docs/getstarted/settings 'Open User settings'). |
| 74 | +- an unobtrusive [**current line blame**](#current-line-blame- 'Jump to the Current Line Blame') annotation at the end of the line with detailed blame information accessible via [**hovers**](#hovers- 'Jump to Hovers') |
| 75 | +- on-demand [**gutter blame**](#gutter-blame- 'Jump to the Gutter Blame') annotations, including a heatmap, for the whole file |
| 76 | +- [**authorship code lens**](#code-lens- 'Jump to the Code Lens') showing the most recent commit and # of authors to the top of files and/or on code blocks |
| 77 | +- on-demand [**gutter heatmap**](#gutter-heatmap- 'Jump to the Gutter Heatmap') annotations to show how recently lines were changed, relative to all the other changes in the file and to now (hot vs. cold) |
| 78 | +- on-demand [**recent changes**](#recent-changes- 'Jump to the Recent Changes') annotations to highlight lines changed by the most recent commit |
| 79 | +- a [**status bar blame**](#status-bar-blame- 'Jump to the Status Bar Blame') annotation showing author and date for the current line |
| 80 | +- many rich Side Bar views |
| 81 | + - a [**_Repositories_ view**](#repositories-view- 'Jump to the Repositories view') to visualize, navigate, and explore Git repositories |
| 82 | + - a [**_File History_ view**](#file-history-view- 'Jump to the File History view') to visualize, navigate, and explore the revision history of the current file |
| 83 | + - a [**_Line History_ view**](#line-history-view- 'Jump to the Line History view') to visualize, navigate, and explore the revision history of the selected lines of current file |
| 84 | + - a [**_Search Commits_ view**](#search-commits-view- 'Jump to the Search Commits view') to search and explore commit histories by message, author, files, id, etc |
| 85 | + - a [**_Compare_ view**](#compare-view- 'Jump to the Compare view') to visualize comparisons between branches, tags, commits, and more |
| 86 | +- many [**powerful commands**](#navigate-and-explore- 'Jump to the Navigate and Explorer') for exploring commits and histories, comparing and navigating revisions, stash access, repository status, etc |
| 87 | +- user-defined [**modes**](#modes- 'Jump to the Modes') for quickly toggling between sets of settings |
| 88 | +- and so much [**more**](#and-more- 'Jump to More') |
81 | 89 |
|
82 | 90 | <p align="center"> |
83 | 91 | <br /> |
84 | 92 | <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/develop/images/docs/gitlens-preview.gif" alt="GitLens Preview" /> |
85 | 93 | <br /> |
86 | 94 | </p> |
87 | 95 |
|
88 | | -# Support GitLens |
89 | | - |
90 | | -While GitLens is generously offered to everyone free of charge, if you find it useful please consider supporting it. |
91 | | - |
92 | | -I've been building GitLens in my spare time<sup><a title="nights and weekends, i.e. trading sleep for time">1</a></sup> for over 2 years now. |
93 | | -From its very humble beginnings, GitLens has grown wildly beyond my expectations — in both its reach as well as its demands on my time and attention. |
94 | | - |
95 | | -To my incredible backers — thank you so much for your contributions. I am truly humbled by your generosity and support. |
96 | | - |
97 | | -### Show Your Support ❤ |
98 | | - |
99 | | -Please join in supporting GitLens by considering the following: |
100 | | - |
101 | | -- [Become a Sponsor](https://www.patreon.com/eamodio 'Become a sponsor on Patreon') — join the growing group of generous [backers](https://github.com/eamodio/vscode-gitlens/blob/master/BACKERS.md) |
102 | | -- [Donate via PayPal](https://www.paypal.me/eamodio 'Donate via PayPal') or [Donate via Cash App](https://cash.me/$eamodio 'Donate via Cash App') |
103 | | -- [Write a review](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens#review-details 'Write a review'), [Star or Fork me on GitHub](https://github.com/eamodio/vscode-gitlens 'Star or fork me on GitHub'), and [Follow me on Twitter](https://twitter.com/eamodio 'Follow me on Twitter') |
104 | | - |
105 | 96 | # Configuration |
106 | 97 |
|
107 | 98 | <p align="center"> |
108 | 99 | <img src="https://raw.githubusercontent.com/eamodio/vscode-gitlens/develop/images/docs/settings.png" alt="GitLens Interactive Settings" /> |
109 | 100 | </p> |
110 | 101 |
|
111 | | -GitLens has a built-in interactive settings editor which provides an easy-to-use interface to configure many of GitLens' powerful features. It can be accessed via the _Open Settings_ (`gitlens.showSettingsPage`) command from the [_Command Palette_](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette). |
| 102 | +GitLens has a built-in **interactive settings editor** which provides an easy-to-use interface to configure many of GitLens' powerful features. It can be accessed via the _Open Settings_ (`gitlens.showSettingsPage`) command from the [_Command Palette_](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette). |
112 | 103 |
|
113 | 104 | For more advanced customizations, refer to the [settings documentation](#gitlens-settings- 'Jump to the GitLens settings docs') below. |
114 | 105 |
|
|
0 commit comments