🐐 Vscode extension README
This commit is contained in:
@@ -1,65 +1,26 @@
|
|||||||
# centvrion README
|
# CENTVRION
|
||||||
|
|
||||||
This is the README for your extension "centvrion". After writing up a brief description, we recommend including the following sections.
|
VSCode extension for [CENTVRION](https://github.com/NikolajDanger/centvrion) — a Latin-inspired esoteric programming language where keywords are Latin words and numbers are Roman numerals.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
|
### Syntax Highlighting
|
||||||
|
|
||||||
For example if there is an image subfolder under your extension project workspace:
|
Provides syntax highlighting for `.cent` files, covering:
|
||||||
|
|
||||||
\!\[feature X\]\(images/feature-x.png\)
|
- **Keywords** — `SI`, `TVNC`, `ALVID`, `DVM`, `FACE`, `PER`, `IN`, `DEFINI`, `VT`, `DESIGNA`, `REDI`, `ERVMPE`, `INVOCA`, and more
|
||||||
|
- **Operators** — `EST` (equality), `MINVS` (less than), `PLVS` (greater than), `ET` (and), `AVT` (or), arithmetic (`+`, `-`, `*`, `/`)
|
||||||
|
- **Built-in functions** — `DICE` (print), `AVDI` (input), `AVDI_NVMERVS`, `FORTIS_NVMERVS`, `FORTIS_ELECTIONIS`, `LONGITVDO`
|
||||||
|
- **Literals** — Roman numeral constants (e.g. `XIV`, `MMXXIV`), booleans (`VERITAS`, `FALSITAS`), null (`NVLLVS`)
|
||||||
|
- **Strings** — single and double quoted, with escape sequences
|
||||||
|
- **Variables** — lowercase Latin identifiers
|
||||||
|
|
||||||
> 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.
|
### Editor Support
|
||||||
|
|
||||||
## Requirements
|
- Auto-closing pairs for `{}`, `[]`, `()`, `""`, `''`
|
||||||
|
- Bracket matching and surrounding selection
|
||||||
|
- Line comments (`//`) and block comments (`/* */`)
|
||||||
|
|
||||||
If you have any requirements or dependencies, add a section describing those and how to install and configure them.
|
## Usage
|
||||||
|
|
||||||
## Extension Settings
|
Open any `.cent` file — syntax highlighting is applied automatically.
|
||||||
|
|
||||||
Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
|
|
||||||
|
|
||||||
For example:
|
|
||||||
|
|
||||||
This extension contributes the following settings:
|
|
||||||
|
|
||||||
* `myExtension.enable`: enable/disable this extension
|
|
||||||
* `myExtension.thing`: set to `blah` to do something
|
|
||||||
|
|
||||||
## Known Issues
|
|
||||||
|
|
||||||
Calling out known issues can help limit users opening duplicate issues against your extension.
|
|
||||||
|
|
||||||
## Release Notes
|
|
||||||
|
|
||||||
Users appreciate release notes as you update your extension.
|
|
||||||
|
|
||||||
### 1.0.0
|
|
||||||
|
|
||||||
Initial release of ...
|
|
||||||
|
|
||||||
### 1.0.1
|
|
||||||
|
|
||||||
Fixed issue #.
|
|
||||||
|
|
||||||
### 1.1.0
|
|
||||||
|
|
||||||
Added features X, Y, and Z.
|
|
||||||
|
|
||||||
-----------------------------------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
## Working with Markdown
|
|
||||||
|
|
||||||
**Note:** You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
|
|
||||||
|
|
||||||
* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux)
|
|
||||||
* Toggle preview (`Shift+CMD+V` on macOS or `Shift+Ctrl+V` on Windows and Linux)
|
|
||||||
* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (macOS) to see a list of Markdown snippets
|
|
||||||
|
|
||||||
### For more information
|
|
||||||
|
|
||||||
* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
|
|
||||||
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
|
|
||||||
|
|
||||||
**Enjoy!**
|
|
||||||
|
|||||||
Reference in New Issue
Block a user