Skip to content

Commit

Permalink
Make the intro to 'run locally' actually talk about running locally.
Browse files Browse the repository at this point in the history
  • Loading branch information
tabatkins committed Dec 2, 2020
1 parent 7968174 commit ab22c20
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 2 deletions.
8 changes: 8 additions & 0 deletions docs/index.bs
Original file line number Diff line number Diff line change
Expand Up @@ -409,6 +409,14 @@ Locally-installed Bikeshed is invoked via the command-line.
There's a bunch of options,
but you'll only use a few in day-to-day use.

If you've installed Bikeshed via one of the standard local installs above,
you can typically just type `bikeshed` in the folder where your `.bs` file lives
and it'll do its thing,
automatically invoking the `spec` subcommand.

However, Bikeshed has a number of different subcommands,
and both global and subcommand-specific flags that can be invoked.

Invoking Bikeshed using a docker image {#cli-docker}
----------------------------------------------------

Expand Down
10 changes: 8 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1484,9 +1484,9 @@
}
}
</style>
<meta content="Bikeshed version 06b67618, updated Wed Dec 2 13:15:01 2020 -0800" name="generator">
<meta content="Bikeshed version 79681745, updated Wed Dec 2 13:40:13 2020 -0800" name="generator">
<link href="https://tabatkins.github.io/bikeshed/" rel="canonical">
<meta content="06b6761828db17da0f38ace3ebab9c98a3711aef" name="document-revision">
<meta content="79681745b4ea29ad132cd6a4038df828e0c09164" name="document-revision">
<style>/* style-autolinks */

.css.css, .property.property, .descriptor.descriptor {
Expand Down Expand Up @@ -2650,6 +2650,12 @@ <h2 class="heading settled" data-level="3" id="cli"><span class="secno">3. </spa
<p>Locally-installed Bikeshed is invoked via the command-line.
There’s a bunch of options,
but you’ll only use a few in day-to-day use.</p>
<p>If you’ve installed Bikeshed via one of the standard local installs above,
you can typically just type <code>bikeshed</code> in the folder where your <code>.bs</code> file lives
and it’ll do its thing,
automatically invoking the <code>spec</code> subcommand.</p>
<p>However, Bikeshed has a number of different subcommands,
and both global and subcommand-specific flags that can be invoked.</p>
<h3 class="heading settled" data-level="3.1" id="cli-docker"><span class="secno">3.1. </span><span class="content">Invoking Bikeshed using a docker image</span><a class="self-link" href="#cli-docker"></a></h3>
<p class="note" role="note"><span>Note:</span> As stated up in <a href="#install-docker">§ 1.6 Building a Bikeshed docker image</a>,
I don’t know how Docker works
Expand Down

0 comments on commit ab22c20

Please sign in to comment.