|
1 | | -# git-codelens README |
| 1 | +# Git CodeLens |
2 | 2 |
|
3 | | -This is the README for your extension "git-codelens". After writing up a brief description, we recommend including the following sections. |
| 3 | +Provides Git blame (and history eventually) CodeLens for many supported Visual Studio Code languages (in theory -- the language must support symbol searching). |
4 | 4 |
|
5 | 5 | ## Features |
6 | 6 |
|
7 | | -Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file. |
| 7 | +Provides CodeLens with the author and date of the last check-in. |
8 | 8 |
|
9 | | -For example if there is an image subfolder under your extension project workspace: |
| 9 | +>  |
10 | 10 |
|
11 | | -\!\[feature X\]\(images/feature-x.png\) |
| 11 | +Clicking on a CodeLens opens a blame "explorer" with the commits and changed lines in the right pane and the commit (file) contents on the left. |
12 | 12 |
|
13 | | -> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow. |
| 13 | +>  |
14 | 14 |
|
15 | 15 | ## Requirements |
16 | 16 |
|
17 | | -If you have any requirements or dependencies, add a section describing those and how to install and configure them. |
| 17 | +Must be using Git and it must be in your path. |
18 | 18 |
|
19 | 19 | ## Extension Settings |
20 | 20 |
|
21 | | -Include if your extension adds any VS Code settings through the `contributes.configuration` extension point. |
22 | | - |
23 | | -For example: |
24 | | - |
25 | | -This extension contributes the following settings: |
26 | | - |
27 | | -* `myExtension.enable`: enable/disable this extension |
28 | | -* `myExtension.thing`: set to `blah` to do something |
| 21 | +None yet. |
29 | 22 |
|
30 | 23 | ## Known Issues |
31 | 24 |
|
32 | | -Calling out known issues can help limit users opening duplicate issues against your extension. |
| 25 | +Too many to count -- this is still very much a work in progress. |
33 | 26 |
|
34 | 27 | ## Release Notes |
35 | 28 |
|
36 | | -Users appreciate release notes as you update your extension. |
37 | | - |
38 | | -### 1.0.0 |
39 | | - |
40 | | -Initial release of ... |
41 | | - |
42 | | -### 1.0.1 |
43 | | - |
44 | | -Fixed issue #. |
45 | | - |
46 | | -### 1.1.0 |
47 | | - |
48 | | -Added features X, Y, and Z. |
49 | | - |
50 | | ------------------------------------------------------------------------------------------------------------ |
51 | | - |
52 | | -## Working with Markdown |
53 | | - |
54 | | -**Note:** You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts: |
55 | | - |
56 | | -* Split the editor (`Cmd+\` on OSX or `Ctrl+\` on Windows and Linux) |
57 | | -* Toggle preview (`Shift+CMD+V` on OSX or `Shift+Ctrl+V` on Windows and Linux) |
58 | | -* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (OSX) to see a list of Markdown snippets |
59 | | - |
60 | | -### For more information |
61 | | - |
62 | | -* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown) |
63 | | -* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/) |
| 29 | +### 0.0.1 |
64 | 30 |
|
65 | | -**Enjoy!** |
| 31 | +Initial release but still heavily a work in progress. |
0 commit comments