diff --git a/README.md b/README.md index 6b0a2bb..2d26ae9 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,47 @@ -# vscode-vhdl-formatter +# VSCode VHDL Formatter VHDL Formatter for Visual Studio Code + +![Visual Studio Marketplace Installs](https://img.shields.io/visual-studio-marketplace/i/Vinrobot.vhdl-formatter.svg?style=flat-square) +![Visual Studio Marketplace Downloads](https://img.shields.io/visual-studio-marketplace/d/Vinrobot.vhdl-formatter.svg?style=flat-square) +![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/Vinrobot.vhdl-formatter.svg?style=flat-square) + +## Installation +Open command palette F1 and select Extensions: Install Extension, then search for 'VHDL Formatter'. + +## Usage + +### Using Command Palette + +- macOS: `CMD` + `SHIFT` + `P` +- Windows: `CTRL` + `SHIFT` + `P` + +And type `Format Document` + +### Keyboard Shortcuts + +- macOS: `SHIFT` + `OPTION` + `F` +- Windows: `SHIFT` + `ALT` + `F` + +If you don't like the defaults shortcuts, you can rebind `editor.action.formatDocument`in the keyboard shortcuts menu of VSCode. + +## Configuration + +| Key | Default | Values | +|------------------------------------|-------------|--------------------------| +| `vhdl.formatter.replaceByAliases` | `false` | `true/false` | +| | | | +| `vhdl.formatter.align.mode` | `Local` | `Local/Global` | +| `vhdl.formatter.align.all` | `false` | `true/false` | +| `vhdl.formatter.align.port` | `false` | `true/false` | +| `vhdl.formatter.align.function` | `false` | `true/false` | +| `vhdl.formatter.align.procedure` | `false` | `true/false` | +| `vhdl.formatter.align.generic` | `false` | `true/false` | +| | | | +| `vhdl.formatter.case.keyword` | `UpperCase` | `UpperCase/LowerCase` | +| `vhdl.formatter.case.typename` | `UpperCase` | `UpperCase/LowerCase` | +| | | | +| `vhdl.formatter.newline.port` | `None` | `NewLine/NoNewLine/None` | +| `vhdl.formatter.newline.then` | `NewLine` | `NewLine/NoNewLine/None` | +| `vhdl.formatter.newline.semicolon` | `NewLine` | `NewLine/NoNewLine/None` | +| `vhdl.formatter.newline.else` | `NewLine` | `NewLine/NoNewLine/None` | +| `vhdl.formatter.newline.generic` | `None` | `NewLine/NoNewLine/None` | diff --git a/package.json b/package.json index 591ffda..457efd9 100755 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "vhdl-formatter", "displayName": "VHDL Formatter", "description": "", - "version": "1.0.0", + "version": "1.0.1", "publisher": "Vinrobot", "engines": { "vscode": "^1.25.0"