aboutsummaryrefslogtreecommitdiff
path: root/vsc-extension-quickstart.md
diff options
context:
space:
mode:
authorGravatar Nathan Graule <solarliner@gmail.com> 2017-05-14 13:36:31 +0200
committerGravatar Nathan Graule <solarliner@gmail.com> 2017-05-14 13:36:31 +0200
commit70c8074cad0e6190268d14cdd5bd5e438cf93eb3 (patch)
treea0dc38d1fb5a7d730f28ddbd0cf60c813c4726a9 /vsc-extension-quickstart.md
parentb2470b9271aeb9af8c86d1f9d0c2d685c5722c36 (diff)
First commit corresponding to release 0.0.1
Diffstat (limited to 'vsc-extension-quickstart.md')
-rw-r--r--vsc-extension-quickstart.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/vsc-extension-quickstart.md b/vsc-extension-quickstart.md
new file mode 100644
index 0000000..7e23978
--- /dev/null
+++ b/vsc-extension-quickstart.md
@@ -0,0 +1,35 @@
+# Welcome to your VS Code Extension
+
+## What's in the folder
+
+* This folder contains all of the files necessary for your color theme extension
+
+* `package.json` - this is the manifest file that defines the location of the theme file and specifies the base theme of the theme
+
+* `themes/Arc Dark-color-theme.json` - the color theme definition file
+
+## Get up and running straight away
+
+* press `F5` to open a new window with your extension loaded
+* open `File > Preferences > Color Themes` and pick your color theme
+* Open a file that has a language associated. The languages' configured grammar will tokenize the text and assign 'scopes' to the tokens. To examine these scopes, invoke the `Inspect TM Scopes` command from the Commmand Palette (`Ctrl+Shift+P` or `Cmd+Shift+R` on Mac) .
+
+## 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
+* When editing workbench colors, it's easiest to test the colors in the settings under `workbench.colorCustomizations`. When done, run the `Generate Color Theme From Current Settings` command to generate an updated content for the color theme definition file.
+
+## Adopt your theme to Visual Studio Code
+
+* The token colorization is done based on standard TextMate themes. Colors are matched against one or more scopes.
+
+To learn about what scopes are used where, check out the [TextMate documentation](https://manual.macromates.com/en/themes)
+and the [Scope Naming](https://www.sublimetext.com/docs/3/scope_naming.html) documentation from Sublime.
+
+* A great place to examine themes is [here](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Monokai).
+
+## Install your extension
+
+* To start using your extension with Visual Studio Code copy it into the `<user home>/.vscode/extensions` folder and restart Code.
+* To share your extension with the world, read on https://code.visualstudio.com/docs about publishing an extension.