quantified.uncertainty/squiggle
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

tweak: Indicate that the configuration step is optional

Browse Source
This commit is contained in:
NunoSempere 2022-07-13 13:39:07 -04:00
parent abedb59a17
commit 42730e980f
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
packages/vscode-ext/README.md
View File

@ -15,7 +15,13 @@ You can install this extension by going to the "extensions" tab, searching for "
![](./images/vs-code-install.png) ![](./images/vs-code-install.png)
### Configuration ## Usage
After loading a `.squiggle` file, an "Open Preview" button will appear. If you click it, the squiggle model will be shown, and updated as you edit and save you file.
![](./images/extension-screenshot.png)
### Configuration (optional)
Some preview settings, e.g. whether to show the summary table or types of outputs, can be configurable on in the VS Code settings and persist between different preview sessions. The VS Code settings can be accessed with the shortcut `Ctrl+,` with `Ctrl+Shift+P` + searching "Open Settings", or by accessing a file like `$HOME/.config/Code/User/settings.json` in Linux (see [here](https://stackoverflow.com/questions/65908987/how-can-i-open-visual-studio-codes-settings-json-file)) for other operating systems. Some preview settings, e.g. whether to show the summary table or types of outputs, can be configurable on in the VS Code settings and persist between different preview sessions. The VS Code settings can be accessed with the shortcut `Ctrl+,` with `Ctrl+Shift+P` + searching "Open Settings", or by accessing a file like `$HOME/.config/Code/User/settings.json` in Linux (see [here](https://stackoverflow.com/questions/65908987/how-can-i-open-visual-studio-codes-settings-json-file)) for other operating systems.
@ -23,12 +29,6 @@ Some preview settings, e.g. whether to show the summary table or types of output
Check out the full list of Squiggle settings in the main VS Code settings. Check out the full list of Squiggle settings in the main VS Code settings.
## Usage
After loading a `.squiggle` file, an "Open Preview" button will appear. If you click it, the squiggle model will be shown, and updated as you edit and save you file.
![](./images/extension-screenshot.png)
## Build locally ## Build locally
We assume you ran `yarn` at the monorepo level for all dependencies. We assume you ran `yarn` at the monorepo level for all dependencies.