~javiljoen/yatte

ed914d078feb7c76e9c64f5733564a01d429f332 — JA Viljoen 2 months ago 74a4284
add design goals to docs
2 files changed, 16 insertions(+), 2 deletions(-)

M README.md
M docs/pages/index.html
M README.md => README.md +7 -0
@@ 15,6 15,13 @@ and its idiosyncracies.
**Yatte** is for when you just want to write a Python script
and get back to work.

Design goals achieved:

- No new syntax for the user to learn: it's just plain Python.
- The user manual fits on an A4 page.
- Implemented in < 400 lines of Python, including comprehensive tests.
- No run-time dependencies except the standard library.


## Project links


M docs/pages/index.html => docs/pages/index.html +9 -2
@@ 13,8 13,15 @@ But maybe you don’t want to invest time in learning a new tool and its idiosyn

<p><strong>Yatte</strong> is for when you just want to write a Python script and get back to work.</p>

<p><em>Note:</em> A promising language-agnostic alternative is
<a href="https://github.com/casey/just/">just</a>.</p>
<section>
<p>Design goals achieved:</p>
<ul>
  <li>No new syntax for the user to learn: it’s just plain Python.</li>
  <li>The user manual fits on an A4 page.</li>
  <li>Implemented in &lt; 400 lines of Python, including comprehensive tests.</li>
  <li>No run-time dependencies except the standard library.</li>
</ul>
</section>

<section>
<p>The <a href="quickstart.html">Quickstart</a> describes how to use Yatte.</p>