~javiljoen/yatte

29073d5cd67fdec9184e7c04d507093ec8b98ce2 — JA Viljoen 9 months ago 6f92a10
Fix development setup instructions in docs
M docs/pages/development.html => docs/pages/development.html +14 -8
@@ 1,15 1,20 @@
<article><h1>Development</h1>
<article>

<p>Install the package in development mode, from the root of the source directory:</p>
<h1>Development</h1>

<pre><code><span class="gp">$ </span>pip install flit
<span class="gp">$ </span>flit install -s</code></pre>
<p>In order to run project-related tasks defined in <code>tasks.py</code>,
  its immediate dependencies must first be installed:</p>

<p>Project-related tasks defined in <code>tasks.py</code>
  can now be run via <code class="cmd">yatte</code> itself:</p>
<pre><code><span class="gp">$ </span>pip install . chevron==0.14</code></pre>

<p>The package can now be installed in development mode
  via <code class="cmd">yatte</code> itself:</p>

<pre><code><span class="gp">$ </span>yatte setup</code></pre>

<p>Other project-related tasks can then be listed and run:</p>

<pre><code><span class="gp">$ </span>yatte
<span class="gp">$ </span>yatte setup
<span class="gp">$ </span>yatte fmt  <span class="c1"># etc.</span></code></pre>

<p>To add a pre-commit hook to check the code when committing,


@@ 20,7 25,8 @@
yatte check</code></pre>

<p><em>Note:</em>
  The <code>wiki</code> task has the following non-Python dependencies:</p>
  The <code>wiki</code> task has the following non-Python dependencies,
  which must be installed separately:</p>

<ul>
  <li><a href="https://pandoc.org">pandoc</a></li>

M docs/pages/index.html => docs/pages/index.html +3 -1
@@ 1,4 1,6 @@
<article><h1>Yatte: a simple task runner</h1>
<article>

<h1>Yatte: a simple task runner</h1>

<p><a href="https://en.wikipedia.org/wiki/Make_(software)">Make</a> and Bash are useful tools
but the syntax can be tricky,

M docs/pages/installation.html => docs/pages/installation.html +3 -1
@@ 1,4 1,6 @@
<article><h1>Installation</h1>
<article>

<h1>Installation</h1>

<p>The package can be installed from the source code repository using <code class="cmd">pip</code>:</p>


M docs/pages/manual.html => docs/pages/manual.html +3 -1
@@ 1,4 1,6 @@
<article><h1>User manual</h1>
<article>

<h1>User manual</h1>

<p>This is the manual page for the <code class="cmd">yatte</code> command-line interface (CLI).</p>


M docs/pages/quickstart.html => docs/pages/quickstart.html +3 -1
@@ 1,4 1,6 @@
<article><h1>Quickstart</h1>
<article>

<h1>Quickstart</h1>

<p>This example demonstrates how to write a task file and run it with <code class="cmd">yatte</code>.</p>