Skip to content

Commit e84e033

Browse files
polytypicpolytypic
committed
Document optional fswatch dependency
1 parent 73c942c commit e84e033

File tree

2 files changed

+36
-11
lines changed

2 files changed

+36
-11
lines changed

‎index.html‎

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,12 @@ <h2><a id="contents"></a> <a href="#contents">≡</a> <a href="#contents">Conten
3434
<ul>
3535
<li><a href="#project-structure">Project structure</a></li>
3636
<li><a href="#cppsm-command"><code>cppsm</code> command</a><ul>
37-
<li><a href="#installation">Installation</a></li>
37+
<li><a href="#installation">Installation</a><ul>
38+
<li><a href="#for-optional-code-formatting">For optional code formatting</a></li>
39+
<li><a href="#for-optional-auto-completion">For optional auto completion</a></li>
40+
<li><a href="#for-optional-watch-commands">For optional watch commands</a></li>
41+
</ul>
42+
</li>
3843
<li><a href="#quick-tour">Quick tour</a></li>
3944
<li><a href="#subcommands">Subcommands</a><ul>
4045
<li><a href="#cppsm-add"><code>cppsm add (requires|equipment) &lt;url&gt; &lt;branch&gt;</code></a></li>
@@ -166,12 +171,22 @@ <h3><a id="installation"></a> <a href="#contents">≡</a> <a href="#installation
166171
<pre><code class="hljs lang-bash">CPPSM=&quot;path to cppsm-cli directory&quot;
167172
export PATH=&quot;$CPPSM/bin:$PATH&quot;
168173
. &quot;$CPPSM/bash_completion&quot;</code></pre>
169-
<p>For code formatting you need to have both
174+
<p>Optional dependencies:</p>
175+
<ul>
176+
<li><p><a id="for-optional-code-formatting"></a><a href="#for-optional-code-formatting">For optional code formatting</a>
177+
you need to have both
170178
<a target="_blank" href="https://clang.llvm.org/docs/ClangFormat.html"><code>clang-format</code> <i class="fas fa-xs fa-external-link-alt"></i></a> and
171179
<a target="_blank" href="https://prettier.io/"><code>prettier</code> <i class="fas fa-xs fa-external-link-alt"></i></a> commands in path.</p>
172-
<p>For the optional auto completion of git urls you must have both
173-
<a target="_blank" href="https://curl.haxx.se/"><code>curl</code> <i class="fas fa-xs fa-external-link-alt"></i></a> and <a target="_blank" href="https://stedolan.github.io/jq/"><code>jq</code> <i class="fas fa-xs fa-external-link-alt"></i></a>
174-
commands in path.</p>
180+
</li>
181+
<li><p><a id="for-optional-auto-completion"></a><a href="#for-optional-auto-completion">For optional auto completion</a>
182+
of git urls you must have both <a target="_blank" href="https://curl.haxx.se/"><code>curl</code> <i class="fas fa-xs fa-external-link-alt"></i></a> and
183+
<a target="_blank" href="https://stedolan.github.io/jq/"><code>jq</code> <i class="fas fa-xs fa-external-link-alt"></i></a> commands in path.</p>
184+
</li>
185+
<li><p><a id="for-optional-watch-commands"></a><a href="#for-optional-watch-commands">For optional watch commands</a>
186+
you must have the <a target="_blank" href="http://emcrisostomo.github.io/fswatch/"><code>fswatch</code> <i class="fas fa-xs fa-external-link-alt"></i></a> command
187+
in path.</p>
188+
</li>
189+
</ul>
175190
<h3><a id="quick-tour"></a> <a href="#contents">≡</a> <a href="#quick-tour">Quick tour</a></h3>
176191
<p>Here is a quick tour of basic <code>cppsm</code> functionality.</p>
177192
<p>Create a new project:</p>

‎index.md‎

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ See [repositories with the `#cppsm` topic](https://github.com/topics/cppsm).
2727
- [Project structure](#project-structure)
2828
- [`cppsm` command](#cppsm-command)
2929
- [Installation](#installation)
30+
- [For optional code formatting](#for-optional-code-formatting)
31+
- [For optional auto completion](#for-optional-auto-completion)
32+
- [For optional watch commands](#for-optional-watch-commands)
3033
- [Quick tour](#quick-tour)
3134
- [Subcommands](#subcommands)
3235
- [`cppsm add (requires|equipment) <url> <branch>`](#cppsm-add)
@@ -154,13 +157,20 @@ export PATH="$CPPSM/bin:$PATH"
154157
. "$CPPSM/bash_completion"
155158
```
156159

157-
For code formatting you need to have both
158-
[`clang-format`](https://clang.llvm.org/docs/ClangFormat.html) and
159-
[`prettier`](https://prettier.io/) commands in path.
160+
Optional dependencies:
160161

161-
For the optional auto completion of git urls you must have both
162-
[`curl`](https://curl.haxx.se/) and [`jq`](https://stedolan.github.io/jq/)
163-
commands in path.
162+
- <a id="for-optional-code-formatting"></a>[For optional code formatting](#for-optional-code-formatting)
163+
you need to have both
164+
[`clang-format`](https://clang.llvm.org/docs/ClangFormat.html) and
165+
[`prettier`](https://prettier.io/) commands in path.
166+
167+
- <a id="for-optional-auto-completion"></a>[For optional auto completion](#for-optional-auto-completion)
168+
of git urls you must have both [`curl`](https://curl.haxx.se/) and
169+
[`jq`](https://stedolan.github.io/jq/) commands in path.
170+
171+
- <a id="for-optional-watch-commands"></a>[For optional watch commands](#for-optional-watch-commands)
172+
you must have the [`fswatch`](http://emcrisostomo.github.io/fswatch/) command
173+
in path.
164174

165175
### <a id="quick-tour"></a> [≡](#contents) [Quick tour](#quick-tour)
166176

0 commit comments

Comments
 (0)