From c00ae873e95662a7fc1bdfcf77d6f463694e05cc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Remko=20Tron=C3=A7on?= Date: Sat, 19 Nov 2022 22:29:27 +0100 Subject: [PATCH] vscode-extension: Update README --- README.md | 15 +++++++++++++++ src/web/vscode-extension/README.md | 12 ++++++++++-- src/web/vscode-extension/package.json | 2 +- 3 files changed, 26 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d984784..d106b83 100644 --- a/README.md +++ b/README.md @@ -155,6 +155,21 @@ forth.interpret(` `); ``` +## Visual Studio Code Notebooks + +The [WAForth Visual Studio Code Extension](https://marketplace.visualstudio.com/items?itemName=remko.waforth-vscode-extension) adds support +for interactive Forth notebooks powered by WAForth. You can execute both text-based Forth code, as well as [Thurtle](https://mko.re/thurtle/) graphics. + +Because it is powered by WebAssembly, this extension works both in the desktop version of Visual Studio Code and in [the browser version of Visual Studio Code](https://code.visualstudio.com/docs/editor/vscode-web) (e.g. https://github.dev, https://vscode.dev). + +
+
+WAForth notebook +
+
WAForth notebook
+
+ + ## Goals Here are some of the goals (and non-goals) of WAForth: diff --git a/src/web/vscode-extension/README.md b/src/web/vscode-extension/README.md index 70df1f3..7747a0d 100644 --- a/src/web/vscode-extension/README.md +++ b/src/web/vscode-extension/README.md @@ -1,6 +1,6 @@ # WAForth VS Code Extension -This extension provides support for [WAForth](https://github.com/remko/waforth) notebooks. +This extension provides support for Forth notebooks, powered by [WAForth](https://github.com/remko/waforth). Choose between a standard (text-based) Forth kernel, and a [Thurtle](https://mko.re/thurtle/) kernel for drawing @@ -11,4 +11,12 @@ Logo-like Forth Turtle graphics. WAForth notebook
WAForth notebook
- \ No newline at end of file + + +## Installation & Usage + +Install the extension from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=remko.waforth-vscode-extension). +Once the extension is installed, you can create a new WAForth notebook from the command pallet (*WAForth: New notebook*), or open [this example notebook](https://raw.githubusercontent.com/remko/waforth/master/src/web/vscode-extension/examples/drawing-with-forth.wafnb). + +The extension also works in the web-based VS Code environments. +For example, install the extension on https://github.dev, and then open [this example notebook](https://github.dev/remko/waforth/blob/master/src/web/vscode-extension/examples/drawing-with-forth.wafnb). diff --git a/src/web/vscode-extension/package.json b/src/web/vscode-extension/package.json index 73d1133..115fe05 100644 --- a/src/web/vscode-extension/package.json +++ b/src/web/vscode-extension/package.json @@ -1,6 +1,6 @@ { "name": "waforth-vscode-extension", - "version": "0.1.5", + "version": "0.1.6", "displayName": "WAForth", "description": "WAForth interactive notebooks", "categories": [