From b8cff23e38bc6cf0a0d2caf0d9a450f22efcd190 Mon Sep 17 00:00:00 2001 From: Olivier Guinart Date: Sun, 24 Sep 2017 12:18:23 -0700 Subject: [PATCH] Updated readmes --- CHANGELOG.md | 8 +++--- README.md | 54 ++++++++----------------------------- vsc-extension-quickstart.md | 27 ------------------- 3 files changed, 16 insertions(+), 73 deletions(-) delete mode 100644 vsc-extension-quickstart.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 62ee0cc..551c9a4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,9 @@ # Change Log All notable changes to the "merlin32" extension will be documented in this file. -Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file. +## [1.0] - 2017-09-24 +- Initial release + - syntax coloring, auto-completion, tooltips on hover -## [Unreleased] -- Initial release \ No newline at end of file + +Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file. diff --git a/README.md b/README.md index f244dda..548ffb8 100644 --- a/README.md +++ b/README.md @@ -1,65 +1,33 @@ # merlin32 README -This is the README for your extension "merlin32". After writing up a brief description, we recommend including the following sections. +Visual Studio Code language extension for 6502 Merlin32 cross-assembler (http://brutaldeluxe.fr/products/crossdevtools/merlin/index.html). + +Provides the ability to develop 6502 assembly programs within a modern IDE. ## Features -Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file. +* Syntax coloring +* Statement completion +* Opcodes tooltip -For example if there is an image subfolder under your extension project workspace: - -\!\[feature X\]\(images/feature-x.png\) - -> 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. +(Images/merlin32VSCodeNearest.gif) ## Requirements -If you have any requirements or dependencies, add a section describing those and how to install and configure them. +N/A ## Extension Settings -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 +Not yet, but coming in a future update, to hold settings such as Merlin32 executable path, and emulator path as well (see `future` branch for a working prototype). ## Known Issues -Calling out known issues can help limit users opening duplicate issues against your extension. + :construction: This is work in progress... ## Release Notes -Users appreciate release notes as you update your extension. ### 1.0.0 -Initial release of ... +Initial release. -### 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 OSX or `Ctrl+\` on Windows and Linux) -* Toggle preview (`Shift+CMD+V` on OSX or `Shift+Ctrl+V` on Windows and Linux) -* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (OSX) 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!** \ No newline at end of file diff --git a/vsc-extension-quickstart.md b/vsc-extension-quickstart.md deleted file mode 100644 index 2d1a636..0000000 --- a/vsc-extension-quickstart.md +++ /dev/null @@ -1,27 +0,0 @@ -# Welcome to your VS Code Extension - -## What's in the folder -* This folder contains all of the files necessary for your extension -* `package.json` - this is the manifest file in which you declare your language support and define -the location of the grammar file that has been copied into you extension. -* `syntaxes/merlin32.tmLanguage.json` - this is the Text mate grammar file that is used for tokenization -* `language-configuration.json` - this the language configuration, defining the tokens that are used for -comments and brackets. - -## Get up and running straight away -* Make sure the language configuration settings in `language-configuration.json` are accurate -* press `F5` to open a new window with your extension loaded -* create a new file with a file name suffix matching your language -* verify that syntax highlight works and that the language configuration settings are working - -## Make changes -* you can relaunch the extension from the debug toolbar after making changes to the files listed above -* you can also reload (`Ctrl+R` or `Cmd+R` on Mac) the VS Code window with your extension to load your changes - -## Add more language features -* To add features such as intellisense, hovers and validators check out the VS Code extenders documentation at -https://code.visualstudio.com/docs - -## Install your extension -* To start using your extension with Visual Studio Code copy it into the `/.vscode/extensions` folder and restart Code. -* To share your extension with the world, read on https://code.visualstudio.com/docs about publishing an extension. \ No newline at end of file