git.iko.soy/vs-code-ormolu
on master help sign in
Updated readme
b0535a7iko
README.md+5−55
compare with master
unifiedsplit
@@ -1,65 +1,15 @@
1−# ormolu README
1+# Ormolu
2−
3−This is the README for your extension "ormolu". After writing up a brief description, we recommend including the following sections.
4−
5−## Features
6−
7−Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
8−
9−For example if there is an image subfolder under your extension project workspace:
10−
11−\!\[feature X\]\(images/feature-x.png\)
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.
14
2
15## Requirements
3## Requirements
16
4
17−If you have any requirements or dependencies, add a section describing those and how to install and configure them.
5+You have to have ormolu installed.
18
6
19−## Extension Settings
7+Go to [github.com/tweag/ormolu](https://github.com/tweag/ormolu#building) for more info.
20
8
21−Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
9+## Extension Settings
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
29−
30−## Known Issues
31−
32−Calling out known issues can help limit users opening duplicate issues against your extension.
33
10
34## Release Notes
11## Release Notes
35
12
36−Users appreciate release notes as you update your extension.
37−
38### 1.0.0
13### 1.0.0
39
14
40−Initial release of ...
15+Initial release of Ormolu
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 macOS or `Ctrl+\` on Windows and Linux)
57−* Toggle preview (`Shift+CMD+V` on macOS or `Shift+Ctrl+V` on Windows and Linux)
58−* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (macOS) 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/)
64−
65−**Enjoy!**