Skip to content

Commit 5914a74

Browse files
committed
Updated readme and version
1 parent 67ef286 commit 5914a74

File tree

2 files changed

+22
-45
lines changed

2 files changed

+22
-45
lines changed

README.md

Lines changed: 21 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,42 @@
1-
# pico8vscodeeditor README
1+
# Pico-8 VSCode Plugin
22

3-
This is the README for your extension "pico8vscodeeditor". After writing up a brief description, we recommend including the following sections.
3+
This plugin provides facilities for editing Pico-8 p8 files in VSCode.
44

55
## Features
66

7-
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
7+
Currently the plugin provides the following features:
88

9-
For example if there is an image subfolder under your extension project workspace:
9+
* Enables LUA syntax highlighting (based off the latest base LUA language plugin)
10+
* Basic LUA language snippets for loops etc.
11+
* Pico-8 API snippets for the (hopefully) whole Pico-8 API
12+
* Additional Pico-8 helper snippets such as:
13+
* Creating new carts
14+
* Helpful "enumerations" for input and colours
15+
* Memory locations/GPIO
16+
* Launching Pico-8 to open or run a cartridge from within VSCode
1017

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.
18+
Wherever Pico-8 has an API where there are a "common" set of parameters, and less used optional ones, the snippet for the optional parameters includes the comma, so they can be quickly deleted if not needed, but you will need to type the comma if you want to use them.
1419

1520
## Requirements
1621

17-
If you have any requirements or dependencies, add a section describing those and how to install and configure them.
18-
19-
## Extension Settings
22+
* VSCode
23+
* Pico-8
2024

21-
Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
25+
:)
2226

23-
For example:
27+
## Extension Settings
2428

2529
This extension contributes the following settings:
2630

27-
* `myExtension.enable`: enable/disable this extension
28-
* `myExtension.thing`: set to `blah` to do something
31+
* `pico8vscodeeditor.pico8fullpath`: full path, including the executable, for Pico-8
32+
* `pico8vscodeeditor.pico8additionalParameters`: any additional parameters to pass to Pico-8 when launching
2933

3034
## Known Issues
3135

32-
Calling out known issues can help limit users opening duplicate issues against your extension.
36+
Documentation needs more info :)
3337

3438
## Release Notes
3539

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 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/)
40+
### 0.1.0
6441

65-
**Enjoy!**
42+
Initial release.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "pico8vscodeeditor",
33
"displayName": "pico8vscodeeditor",
44
"description": "VSCode editor for Pico-8 .p8 files with basic lua and pico8 api snippets.",
5-
"version": "0.0.1",
5+
"version": "0.1.0",
66
"repository": {
77
"type": "git",
88
"url": "https://github.com/grumpydev/pico8vscodeeditor"

0 commit comments

Comments
 (0)