<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>vscode-extension/README.md - fork/numbat @ v1.6.0</title>
<meta name="description" content="vscode-extension/README.md in fork/numbat at v1.6.0.">
<meta property="og:title" content="vscode-extension/README.md - fork/numbat @ v1.6.0">
<meta property="og:description" content="vscode-extension/README.md in fork/numbat at v1.6.0.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="v1.6.0" data-tip="7b5a850e7da74758ace2b3751af0de349c60dbae">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/numbat</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/numbat</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">David Peter</span><span class="commit-message" data-commit="ae7be9b3e4fca8b947539aba9558e40c00143199">Rename project to Numbat</span><span class="snapshot-sha sha" data-commit="ae7be9b3e4fca8b947539aba9558e40c00143199">ae7be9b</span><time datetime="2023-03-01T08:30:05+01:00" title="2023-03-01 08:30:05 +0100">2023-03-01</time></p>
<header class="topbar"><details class="switcher"><summary>v1.6.0</summary><div class="menu"><strong>branches</strong><a href="/fork/numbat/ref/master/">master</a><strong>tags</strong><a class="current" href="/fork/numbat/ref/v1.6.0/">v1.6.0</a><a href="/fork/numbat/ref/v1.6.1/">v1.6.1</a><a href="/fork/numbat/ref/v1.6.2/">v1.6.2</a><a href="/fork/numbat/ref/v1.6.3/">v1.6.3</a><a href="/fork/numbat/ref/v1.7.0/">v1.7.0</a><a href="/fork/numbat/ref/v1.8.0/">v1.8.0</a><a class="all" href="/fork/numbat/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/numbat/">numbat</a> / <a href="/fork/numbat/ref/v1.6.0/tree/vscode-extension/">vscode-extension</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>2.0 KiB</span><span>65 lines</span></span><span class="actions"><a class="raw" href="/fork/numbat/raw/ca91b26d906c9eb8578e4cacf863df2d22300db9/vscode-extension/README.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>numbat README</h1>
<p>This is the README for your extension "numbat". After writing up a brief description, we recommend including the following sections.</p>
<h2>Features</h2>
<p>Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.</p>
<p>For example if there is an image subfolder under your extension project workspace:</p>
<p>![feature X](images/feature-x.png)</p>
<blockquote>
<p>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.</p>
</blockquote>
<h2>Requirements</h2>
<p>If you have any requirements or dependencies, add a section describing those and how to install and configure them.</p>
<h2>Extension Settings</h2>
<p>Include if your extension adds any VS Code settings through the <code>contributes.configuration</code> extension point.</p>
<p>For example:</p>
<p>This extension contributes the following settings:</p>
<ul>
<li><code>myExtension.enable</code>: enable/disable this extension</li>
<li><code>myExtension.thing</code>: set to <code>blah</code> to do something</li>
</ul>
<h2>Known Issues</h2>
<p>Calling out known issues can help limit users opening duplicate issues against your extension.</p>
<h2>Release Notes</h2>
<p>Users appreciate release notes as you update your extension.</p>
<h3>1.0.0</h3>
<p>Initial release of ...</p>
<h3>1.0.1</h3>
<p>Fixed issue #.</p>
<h3>1.1.0</h3>
<p>Added features X, Y, and Z.</p>
<hr />
<h2>Working with Markdown</h2>
<p><strong>Note:</strong> You can author your README using Visual Studio Code.  Here are some useful editor keyboard shortcuts:</p>
<ul>
<li>Split the editor (<code>Cmd+\</code> on macOS or <code>Ctrl+\</code> on Windows and Linux)</li>
<li>Toggle preview (<code>Shift+CMD+V</code> on macOS or <code>Shift+Ctrl+V</code> on Windows and Linux)</li>
<li>Press <code>Ctrl+Space</code> (Windows, Linux) or <code>Cmd+Space</code> (macOS) to see a list of Markdown snippets</li>
</ul>
<h3>For more information</h3>
<ul>
<li><a href="http://code.visualstudio.com/docs/languages/markdown">Visual Studio Code's Markdown Support</a></li>
<li><a href="https://help.github.com/articles/markdown-basics/">Markdown Syntax Reference</a></li>
</ul>
<p><strong>Enjoy!</strong></p>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>numbat README</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">This is the README for your extension &quot;numbat&quot;. After writing up a brief description, we recommend including the following sections.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"><a-p>##</a-p> <a-tt>Features</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">For example if there is an image subfolder under your extension project workspace:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">\!\[feature X\]\(images/feature-x.png\)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>&gt; </a-p>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.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>##</a-p> <a-tt>Requirements</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text">If you have any requirements or dependencies, add a section describing those and how to install and configure them.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>##</a-p> <a-tt>Extension Settings</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text">Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text">For example:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text">This extension contributes the following settings:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>* </a-p>`myExtension.enable`: enable/disable this extension</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>* </a-p>`myExtension.thing`: set to `blah` to do something</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>## </a-p><a-tt>Known Issues</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p>Calling out known issues can help limit users opening duplicate issues against your extension.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>## </a-p><a-tt>Release Notes</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"><a-p>Users appreciate release notes as you update your extension.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"><a-p>### </a-p><a-tt>1.0.0</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>Initial release of ...</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>### </a-p><a-tt>1.0.1</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p>Fixed issue #.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p>### </a-p><a-tt>1.1.0</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"><a-p>Added features X, Y, and Z.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-p>-----------------------------------------------------------------------------------------------------------</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"><a-p>## </a-p><a-tt>Working with Markdown</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"><a-p>**Note:** You can author your README using Visual Studio Code.  Here are some useful editor keyboard shortcuts:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"><a-p>* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"><a-p>* Toggle preview (`Shift+CMD+V` on macOS or `Shift+Ctrl+V` on Windows and Linux)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"><a-p>* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (macOS) to see a list of Markdown snippets</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"><a-p>### </a-p><a-tt>For more information</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"><a-p>* [Visual Studio Code&#39;s Markdown Support](http://code.visualstudio.com/docs/languages/markdown)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"><a-p>* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text">**Enjoy!**</span></span></pre></div></div>
</main>
</body>
</html>
