Merge pull request #8 from AdrienChampion/master

Preparing for release: versioning and travis badge

README.md

@@ -1,6 +1,6 @@
-# Techelson
+# Techelson [![Build Status](https://travis-ci.org/AdrienChampion/techelson.svg?branch=master)](https://travis-ci.org/AdrienChampion/techelson)
 
-TEst miCHELSON: `techelson`
+TEst miCHELSON: `techelson`.
 
 A test execution engine for Michelson smart contracts.
 
@@ -49,7 +49,7 @@ You can also run `make test` to make sure there is no problem with the Techelson
 Assuming the binary Techelson is in you path, you can run it with
 
 ```bash
-> techelson [ --contract <contract_file> <optional_init_file> ]* -- [ <testcase> ]*
+> techelson [ --contract <contract_file> ]* -- [ <testcase> ]*
 ```
 
 Argument `<contract_file>` is a michelson contract (`storage`, `parameter` and `code` fields). `<optional_init_file>` is an optional initializer for the contract. It should contain two fields : `parameter` and `code`. The former is the type of data the initializer takes as input, and the latter is a (sequence of) michelson instruction(s) which, from a stack with a value of type `parameter`, produces a stack with a value of the `storage` type appearing in the `<contract_file>` associated with the initializer.

docs/index.md

@@ -1,6 +1,6 @@
-# Techelson
+# Techelson [![Build Status](https://travis-ci.org/AdrienChampion/techelson.svg?branch=master)](https://travis-ci.org/AdrienChampion/techelson)
 
-TEst miCHELSON: `techelson`
+TEst miCHELSON: `techelson`.
 
 A test execution engine for Michelson smart contracts.
 
@@ -49,7 +49,7 @@ You can also run `make test` to make sure there is no problem with the Techelson
 Assuming the binary Techelson is in you path, you can run it with
 
 ```bash
-> techelson [ --contract <contract_file> <optional_init_file> ]* -- [ <testcase> ]*
+> techelson [ --contract <contract_file> ]* -- [ <testcase> ]*
 ```
 
 Argument `<contract_file>` is a michelson contract (`storage`, `parameter` and `code` fields). `<optional_init_file>` is an optional initializer for the contract. It should contain two fields : `parameter` and `code`. The former is the type of data the initializer takes as input, and the latter is a (sequence of) michelson instruction(s) which, from a stack with a value of type `parameter`, produces a stack with a value of the `storage` type appearing in the `<contract_file>` associated with the initializer.

docs/user_doc/index.html

@@ -143,7 +143,9 @@ <h1 class="menu-title">Techelson User Documentation</h1>
                         <a class="header" href="#techelson" id="techelson"><h1>Techelson</h1></a>
 <p><strong><a href="https://ocamlpro.github.io/techelson" title="Techelson's homepage">Techelson</a></strong> is a <strong>T</strong>est <strong>E</strong>xecution <strong>E</strong>nvironment (TEE) for <a href="https://tezos.gitlab.io/master/whitedoc/michelson.html" title="Michelson documentation page">Michelson smart contracts</a>.
 Michelson is the stack-based language used by the <a href="https://tezos.com" title="Tezos official page">tezos blockchain</a>. Techelson is open
-source and <a href="https://github.com/OCamlPro/techelson" title="Techelson on github.com">hosted on github</a>, where you can find the build instructions.</p>
+source and <a href="https://github.com/OCamlPro/techelson" title="Techelson on github.com">hosted on github</a>, where you can find the build instructions. If you just want to
+retrieve a binary, head over to <a href="https://github.com/OCamlPro/techelson/releases" title="Techelson's release page">releases</a>.</p>
+<p>If you have problems or suggestions, help us make Techelson better by <a href="https://github.com/OCamlPro/techelson/issues" title="Techelson's issue tracker">opening an issue</a>.</p>
 <p>Techelson emulates just enough of the tezos blockchain protocol to be able to create smart
 contracts and make transfers between contracts. Currently, techelson only aims at testing
 functional properties of smart contracts. In particular, it does not provide any information about

docs/user_doc/print.html

@@ -143,7 +143,9 @@ <h1 class="menu-title">Techelson User Documentation</h1>
                         <a class="header" href="#techelson" id="techelson"><h1>Techelson</h1></a>
 <p><strong><a href="https://ocamlpro.github.io/techelson" title="Techelson's homepage">Techelson</a></strong> is a <strong>T</strong>est <strong>E</strong>xecution <strong>E</strong>nvironment (TEE) for <a href="https://tezos.gitlab.io/master/whitedoc/michelson.html" title="Michelson documentation page">Michelson smart contracts</a>.
 Michelson is the stack-based language used by the <a href="https://tezos.com" title="Tezos official page">tezos blockchain</a>. Techelson is open
-source and <a href="https://github.com/OCamlPro/techelson" title="Techelson on github.com">hosted on github</a>, where you can find the build instructions.</p>
+source and <a href="https://github.com/OCamlPro/techelson" title="Techelson on github.com">hosted on github</a>, where you can find the build instructions. If you just want to
+retrieve a binary, head over to <a href="https://github.com/OCamlPro/techelson/releases" title="Techelson's release page">releases</a>.</p>
+<p>If you have problems or suggestions, help us make Techelson better by <a href="https://github.com/OCamlPro/techelson/issues" title="Techelson's issue tracker">opening an issue</a>.</p>
 <p>Techelson emulates just enough of the tezos blockchain protocol to be able to create smart
 contracts and make transfers between contracts. Currently, techelson only aims at testing
 functional properties of smart contracts. In particular, it does not provide any information about
@@ -2046,40 +2048,44 @@ <h1 class="menu-title">Techelson User Documentation</h1>
 <li>
 <p><code>STEP</code> and <code>STEP &lt;string&gt;</code>:</p>
 <p><code>'S</code> <code>-&gt;</code> <code>'S</code></p>
-<p>Relevant section of this book: <a href="quick_ref/../testing/basic.html" title="First Steps section">First Steps</a>.</p>
+<p>Since <code>0.7.0</code>, relevant section of this book: <a href="quick_ref/../testing/basic.html" title="First Steps section">First Steps</a>.</p>
 <p>suspends the evaluator and prints a string, if any.</p>
 </li>
 <li>
 <p><code>PRINT_STACK</code>:</p>
 <p><code>'S</code> <code>-&gt;</code> <code>'S</code></p>
-<p>Relevant section of this book: <a href="quick_ref/../testing/basic.html" title="First Steps section">First Steps</a>.</p>
+<p>Since <code>0.7.0</code>, relevant section of this book: <a href="quick_ref/../testing/basic.html" title="First Steps section">First Steps</a>.</p>
 <p>prints the current state of the stack</p>
 </li>
 </ul>
+<blockquote>
+<p>Note that Techelson treats <code>#&gt;</code> as whitespaces. You can have <code>#&gt; STEP &quot;important step&quot; ;</code> in your
+contracts which keeps them pure Michelson, but Techelson will stop when it reaches the <code>STEP</code>.</p>
+</blockquote>
 <a class="header" href="#testcase-only-extensions" id="testcase-only-extensions"><h2>Testcase-only Extensions</h2></a>
 <p>The following instructions are <strong>only</strong> legal in testcases:</p>
 <ul>
 <li>
 <p><code>CREATE_CONTRACT &lt;string&gt;</code>:</p>
 <p><code>:: key_hash : option key_hash : bool : bool : mutez : 'g : 'S</code>
 <code>-&gt;</code> <code>operation : address : 'S</code></p>
-<p>Relevant section of this book: <a href="quick_ref/../testing/contracts.html" title="Creating and Calling Contracts section">Creating and Calling Contracts</a>.</p>
+<p>Since <code>0.7.0</code>, relevant section of this book: <a href="quick_ref/../testing/contracts.html" title="Creating and Calling Contracts section">Creating and Calling Contracts</a>.</p>
 <p>Creates an instance of the contract named after the string parameter. The type of the storage
 of the contract must be <code>'g</code>.</p>
 </li>
 <li>
 <p><code>SPAWN_CONTRACT 'g</code>:</p>
 <p><code>:: string : key_hash : option key_hash : bool : bool : mutez : 'g : 'S</code>
 <code>-&gt;</code> <code>operation : address : 'S</code></p>
-<p>Relevant section of this book: <a href="quick_ref/../testing/contracts.html" title="Creating and Calling Contracts section">Creating and Calling Contracts</a>.</p>
+<p>Since <code>0.7.0</code>, relevant section of this book: <a href="quick_ref/../testing/contracts.html" title="Creating and Calling Contracts section">Creating and Calling Contracts</a>.</p>
 <p>Exactly the same as the <code>CREATE_CONTRACT</code> extension above but the name of the contract is
 passed as a stack parameter, and the type of the storage is an explicit parameter of the
 instruction.</p>
 </li>
 <li>
 <p><code>APPLY_OPERATIONS</code>:</p>
 <p><code>(list operation) : 'S</code> <code>-&gt;</code> <code>'S</code></p>
-<p>Relevant section of this book: <a href="quick_ref/../testing/contracts.html" title="Creating and Calling Contracts section">Creating and Calling Contracts</a>.</p>
+<p>Since <code>0.7.0</code>, relevant section of this book: <a href="quick_ref/../testing/contracts.html" title="Creating and Calling Contracts section">Creating and Calling Contracts</a>.</p>
 <ul>
 <li>consumes a list of operations</li>
 <li>suspends the execution of the testcase</li>
@@ -2092,7 +2098,7 @@ <h1 class="menu-title">Techelson User Documentation</h1>
 <p><code>GET_STORAGE 'storage</code>:</p>
 <p><code>contract _ : 'S</code> <code>-&gt;</code> <code>(option 'storage) : 'S</code></p>
 <p><code>address : 'S</code> <code>-&gt;</code> <code>(option 'storage) : 'S</code></p>
-<p>Relevant section of this book: <a href="quick_ref/../testing/inspection.html" title="Live Contract Inspection section">Live Contract Inspection</a>.</p>
+<p>Since <code>0.7.0</code>, relevant section of this book: <a href="quick_ref/../testing/inspection.html" title="Live Contract Inspection section">Live Contract Inspection</a>.</p>
 <ul>
 <li>consumes a contract</li>
 <li>pushes <code>Some</code> of the current value of the storage of the contract if its storage has type
@@ -2103,13 +2109,13 @@ <h1 class="menu-title">Techelson User Documentation</h1>
 <p><code>GET_BALANCE</code>:</p>
 <p><code>contract _ : 'S</code> <code>-&gt;</code> <code>mutez : 'S</code></p>
 <p><code>address : 'S</code> <code>-&gt;</code> <code>mutez : 'S</code></p>
-<p>Relevant section of this book: <a href="quick_ref/../testing/inspection.html" title="Live Contract Inspection section">Live Contract Inspection</a>.</p>
+<p>Since <code>0.7.0</code>, relevant section of this book: <a href="quick_ref/../testing/inspection.html" title="Live Contract Inspection section">Live Contract Inspection</a>.</p>
 <p>Same as <code>GET_STORAGE</code>, but pushes the balance of the contract instead of its storage</p>
 </li>
 <li>
 <p><code>MUST_FAIL 'a</code>:</p>
 <p><code>(option 'a) : operation : 'S</code> <code>-&gt;</code> <code>'S</code></p>
-<p>Relevant section of this book: <a href="quick_ref/../testing/failures.html" title="Testing for Failures section">Testing for Failures</a>.</p>
+<p>Since <code>0.7.0</code>, relevant section of this book: <a href="quick_ref/../testing/failures.html" title="Testing for Failures section">Testing for Failures</a>.</p>
 <p>Specifies that an operation (or the operation it creates recursively) must fail, and optionaly
 that it <code>FAIL</code>ed<code>WITH</code> a certain value. More precisely, the whole testcase will <strong>fail</strong> if the
 <code>operation</code> or the operations it creates recursively, <em>when applied</em>, either</p>
@@ -2128,15 +2134,15 @@ <h1 class="menu-title">Techelson User Documentation</h1>
 <li>
 <p><code>SET_SOURCE code</code>, with <code>code :: [ 'A -&gt; 'B ]</code></p>
 <p><code>address :: 'A</code> <code>-&gt;</code> <code>'B</code></p>
-<p>Relevant section of this book: <a href="quick_ref/../testing/set_source.html" title="Usurpation of Identity section">Usurpation of Identity</a>.</p>
+<p>Since <code>0.7.0</code>, relevant section of this book: <a href="quick_ref/../testing/set_source.html" title="Usurpation of Identity section">Usurpation of Identity</a>.</p>
 <p>Sets the source of the testcase. Without this extension, the source of all transfers can only
 be the testcase. This allows to run <code>code</code> while pretending the testcase is a different live
 contract.</p>
 </li>
 <li>
 <p><code>SET_TIMESTAMP</code></p>
 <p><code>timestamp :: 'S</code> <code>-&gt;</code> <code>'S</code></p>
-<p>Relevant section of this book: <a href="quick_ref/../testing/time.html" title="Timestame Control section">Timestamp Control</a>.</p>
+<p>Since <code>0.7.0</code>, relevant section of this book: <a href="quick_ref/../testing/time.html" title="Timestame Control section">Timestamp Control</a>.</p>
 <p>Sets the timestamp of the next block to some value. The default timestamp is
 <code>1970-01-01T00:00:00Z</code>.</p>
 </li>
@@ -2148,6 +2154,8 @@ <h1 class="menu-title">Techelson User Documentation</h1>
 </blockquote>
 <p>The full list of options (for the nominal mode) is obtained with <code>--help</code>:</p>
 <pre><code>$ techelson --help
+techelson v0.7.0
+
 USAGE:
     ../bin/techelson [OPTIONS] -- [FILES]*
     ../bin/techelson [OPTIONS] testgen [TESTGEN_OPTIONS] [-- DIR]?

docs/user_doc/quick_ref/extensions.html

@@ -167,40 +167,44 @@ <h1 class="menu-title">Techelson User Documentation</h1>
 <li>
 <p><code>STEP</code> and <code>STEP &lt;string&gt;</code>:</p>
 <p><code>'S</code> <code>-&gt;</code> <code>'S</code></p>
-<p>Relevant section of this book: <a href="../testing/basic.html" title="First Steps section">First Steps</a>.</p>
+<p>Since <code>0.7.0</code>, relevant section of this book: <a href="../testing/basic.html" title="First Steps section">First Steps</a>.</p>
 <p>suspends the evaluator and prints a string, if any.</p>
 </li>
 <li>
 <p><code>PRINT_STACK</code>:</p>
 <p><code>'S</code> <code>-&gt;</code> <code>'S</code></p>
-<p>Relevant section of this book: <a href="../testing/basic.html" title="First Steps section">First Steps</a>.</p>
+<p>Since <code>0.7.0</code>, relevant section of this book: <a href="../testing/basic.html" title="First Steps section">First Steps</a>.</p>
 <p>prints the current state of the stack</p>
 </li>
 </ul>
+<blockquote>
+<p>Note that Techelson treats <code>#&gt;</code> as whitespaces. You can have <code>#&gt; STEP &quot;important step&quot; ;</code> in your
+contracts which keeps them pure Michelson, but Techelson will stop when it reaches the <code>STEP</code>.</p>
+</blockquote>
 <a class="header" href="#testcase-only-extensions" id="testcase-only-extensions"><h2>Testcase-only Extensions</h2></a>
 <p>The following instructions are <strong>only</strong> legal in testcases:</p>
 <ul>
 <li>
 <p><code>CREATE_CONTRACT &lt;string&gt;</code>:</p>
 <p><code>:: key_hash : option key_hash : bool : bool : mutez : 'g : 'S</code>
 <code>-&gt;</code> <code>operation : address : 'S</code></p>
-<p>Relevant section of this book: <a href="../testing/contracts.html" title="Creating and Calling Contracts section">Creating and Calling Contracts</a>.</p>
+<p>Since <code>0.7.0</code>, relevant section of this book: <a href="../testing/contracts.html" title="Creating and Calling Contracts section">Creating and Calling Contracts</a>.</p>
 <p>Creates an instance of the contract named after the string parameter. The type of the storage
 of the contract must be <code>'g</code>.</p>
 </li>
 <li>
 <p><code>SPAWN_CONTRACT 'g</code>:</p>
 <p><code>:: string : key_hash : option key_hash : bool : bool : mutez : 'g : 'S</code>
 <code>-&gt;</code> <code>operation : address : 'S</code></p>
-<p>Relevant section of this book: <a href="../testing/contracts.html" title="Creating and Calling Contracts section">Creating and Calling Contracts</a>.</p>
+<p>Since <code>0.7.0</code>, relevant section of this book: <a href="../testing/contracts.html" title="Creating and Calling Contracts section">Creating and Calling Contracts</a>.</p>
 <p>Exactly the same as the <code>CREATE_CONTRACT</code> extension above but the name of the contract is
 passed as a stack parameter, and the type of the storage is an explicit parameter of the
 instruction.</p>
 </li>
 <li>
 <p><code>APPLY_OPERATIONS</code>:</p>
 <p><code>(list operation) : 'S</code> <code>-&gt;</code> <code>'S</code></p>
-<p>Relevant section of this book: <a href="../testing/contracts.html" title="Creating and Calling Contracts section">Creating and Calling Contracts</a>.</p>
+<p>Since <code>0.7.0</code>, relevant section of this book: <a href="../testing/contracts.html" title="Creating and Calling Contracts section">Creating and Calling Contracts</a>.</p>
 <ul>
 <li>consumes a list of operations</li>
 <li>suspends the execution of the testcase</li>
@@ -213,7 +217,7 @@ <h1 class="menu-title">Techelson User Documentation</h1>
 <p><code>GET_STORAGE 'storage</code>:</p>
 <p><code>contract _ : 'S</code> <code>-&gt;</code> <code>(option 'storage) : 'S</code></p>
 <p><code>address : 'S</code> <code>-&gt;</code> <code>(option 'storage) : 'S</code></p>
-<p>Relevant section of this book: <a href="../testing/inspection.html" title="Live Contract Inspection section">Live Contract Inspection</a>.</p>
+<p>Since <code>0.7.0</code>, relevant section of this book: <a href="../testing/inspection.html" title="Live Contract Inspection section">Live Contract Inspection</a>.</p>
 <ul>
 <li>consumes a contract</li>
 <li>pushes <code>Some</code> of the current value of the storage of the contract if its storage has type
@@ -224,13 +228,13 @@ <h1 class="menu-title">Techelson User Documentation</h1>
 <p><code>GET_BALANCE</code>:</p>
 <p><code>contract _ : 'S</code> <code>-&gt;</code> <code>mutez : 'S</code></p>
 <p><code>address : 'S</code> <code>-&gt;</code> <code>mutez : 'S</code></p>
-<p>Relevant section of this book: <a href="../testing/inspection.html" title="Live Contract Inspection section">Live Contract Inspection</a>.</p>
+<p>Since <code>0.7.0</code>, relevant section of this book: <a href="../testing/inspection.html" title="Live Contract Inspection section">Live Contract Inspection</a>.</p>
 <p>Same as <code>GET_STORAGE</code>, but pushes the balance of the contract instead of its storage</p>
 </li>
 <li>
 <p><code>MUST_FAIL 'a</code>:</p>
 <p><code>(option 'a) : operation : 'S</code> <code>-&gt;</code> <code>'S</code></p>
-<p>Relevant section of this book: <a href="../testing/failures.html" title="Testing for Failures section">Testing for Failures</a>.</p>
+<p>Since <code>0.7.0</code>, relevant section of this book: <a href="../testing/failures.html" title="Testing for Failures section">Testing for Failures</a>.</p>
 <p>Specifies that an operation (or the operation it creates recursively) must fail, and optionaly
 that it <code>FAIL</code>ed<code>WITH</code> a certain value. More precisely, the whole testcase will <strong>fail</strong> if the
 <code>operation</code> or the operations it creates recursively, <em>when applied</em>, either</p>
@@ -249,15 +253,15 @@ <h1 class="menu-title">Techelson User Documentation</h1>
 <li>
 <p><code>SET_SOURCE code</code>, with <code>code :: [ 'A -&gt; 'B ]</code></p>
 <p><code>address :: 'A</code> <code>-&gt;</code> <code>'B</code></p>
-<p>Relevant section of this book: <a href="../testing/set_source.html" title="Usurpation of Identity section">Usurpation of Identity</a>.</p>
+<p>Since <code>0.7.0</code>, relevant section of this book: <a href="../testing/set_source.html" title="Usurpation of Identity section">Usurpation of Identity</a>.</p>
 <p>Sets the source of the testcase. Without this extension, the source of all transfers can only
 be the testcase. This allows to run <code>code</code> while pretending the testcase is a different live
 contract.</p>
 </li>
 <li>
 <p><code>SET_TIMESTAMP</code></p>
 <p><code>timestamp :: 'S</code> <code>-&gt;</code> <code>'S</code></p>
-<p>Relevant section of this book: <a href="../testing/time.html" title="Timestame Control section">Timestamp Control</a>.</p>
+<p>Since <code>0.7.0</code>, relevant section of this book: <a href="../testing/time.html" title="Timestame Control section">Timestamp Control</a>.</p>
 <p>Sets the timestamp of the next block to some value. The default timestamp is
 <code>1970-01-01T00:00:00Z</code>.</p>
 </li>

docs/user_doc/quick_ref/usage.html

@@ -147,6 +147,8 @@ <h1 class="menu-title">Techelson User Documentation</h1>
 </blockquote>
 <p>The full list of options (for the nominal mode) is obtained with <code>--help</code>:</p>
 <pre><code>$ techelson --help
+techelson v0.7.0
+
 USAGE:
     ../bin/techelson [OPTIONS] -- [FILES]*
     ../bin/techelson [OPTIONS] testgen [TESTGEN_OPTIONS] [-- DIR]?