Skip to content

Commit

Permalink
Updating HTML
Browse files Browse the repository at this point in the history
  • Loading branch information
Neyromancer committed Nov 3, 2023
1 parent f6117b0 commit 3656fda
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 16 deletions.
29 changes: 20 additions & 9 deletions docs/book/development.html
Original file line number Diff line number Diff line change
Expand Up @@ -156,19 +156,18 @@ <h2 id="requirements"><a class="header" href="#requirements">Requirements</a></h
<h2 id="installation"><a class="header" href="#installation">Installation</a></h2>
<p>You need to first <em>clone</em> this repository and run:</p>
<pre><code class="language-bash">❯ cd zombienet
❯ npm install
❯ npm run build
❯ npm i && npm run build
</code></pre>
<h3 id="download-and-install-needed-artifacts-optional"><a class="header" href="#download-and-install-needed-artifacts-optional">Download and install needed artifacts (optional)</a></h3>
<p>For an easier and faster setup of your local environment, run:</p>
<pre><code class="language-bash">❯ cd zombinet/javascript/packages && node ./cli/dist/cli.js setup &lt;binaries&gt;
<pre><code class="language-bash">❯ cd zombinet/javascript && npm i && npm run zombie -- setup &lt;binaries&gt;
</code></pre>
<p>This allows to use the <code>setup</code> script, making everything ready for a ZombieNet dev environment.</p>
<p>You can use the following arguments:</p>
<p><code>--help</code> shows the different options and commands for using the Zombienet CLI.
<code>--binaries</code> or <code>-b</code>: enables providing the binaries that you want to be downloaded and installed during the setup. Possible options: <code>polkadot</code>, <code>polkadot-parachain</code>.</p>
<p>For example:</p>
<pre><code class="language-bash">❯ cd zombinet/javascript/packages && node ./cli/dist/cli.js setup polkadot polkadot-parachain
<pre><code class="language-bash">❯ cd zombinet/javascript && npm i && npm run zombie -- setup polkadot polkadot-parachain
</code></pre>
<blockquote>
<p>Note: If you are using macOS please clone the <a href="https://github.com/paritytech/polkadot-sdk">polkadot-sdk repo</a> and run it locally. At the moment there is no <code>polkadot</code> binary for MacOs.</p>
Expand All @@ -179,18 +178,30 @@ <h3 id="download-and-install-needed-artifacts-optional"><a class="header" href="
</code></pre>
<h3 id="using-zombienet"><a class="header" href="#using-zombienet">Using Zombienet</a></h3>
<p>With the above steps completed, the <code>zombienet</code> CLI is ready to run:</p>
<pre><code class="language-bash">❯ cd zombinet/javascript/packages && node ./cli/dist/cli.js
<pre><code class="language-bash">❯ cd zombinet/javascript && npm run zombie

Usage: zombienet [options] [command]

Options:
-c, --spawn-concurrency &lt;concurrency&gt; Number of concurrent spawning process to launch,
default is 1
-p, --provider &lt;provider&gt; Override provider to use (choices: &quot;podman&quot;,
&quot;kubernetes&quot;, default: kubernetes)
-h, --help display help for command
&quot;kubernetes&quot;, &quot;native&quot;)
-l, --logType &lt;logType&gt; Type of logging - defaults to &quot;table&quot;
(choices: &quot;table&quot;, &quot;text&quot;, &quot;silent&quot;)
-d, --dir &lt;path&gt; Directory path for placing the network files instead of random temp one
(e.g. -d /home/user/my-zombienet)
-f, --force Force override all prompt commands
-h, --help Display help for command

Commands:
spawn &lt;networkConfig&gt; [creds] [monitor] Spawn the network defined in the config
test &lt;testFile&gt; Run tests on the network defined
spawn [options] &lt;networkConfig&gt; [creds] Spawn the network defined in the config
test &lt;testFile&gt; [runningNetworkSpec] Run tests on the network defined
setup [options] &lt;binaries...&gt; Setup is meant for downloading and making
dev environment of ZombieNet ready
convert &lt;filePath&gt; Convert is meant for transforming a
(now deprecated) polkadot-launch configuration
to zombienet configuration
version Prints zombienet version
help [command] display help for command
</code></pre>
Expand Down
26 changes: 19 additions & 7 deletions docs/book/print.html
Original file line number Diff line number Diff line change
Expand Up @@ -1690,7 +1690,7 @@ <h3 id="download-and-install-needed-artifacts-optional">
<p>
For an easier and faster setup of your local environment, run:
</p>
<pre><code class="language-bash">cd zombinet/javascript/packages && node ./cli/dist/cli.js setup &lt;binaries&gt;
<pre><code class="language-bash">cd zombinet/javascript && npm i && npm run zombie -- setup &lt;binaries&gt;
</code></pre>
<p>
This allows to use the <code>setup</code> script, making
Expand All @@ -1705,7 +1705,7 @@ <h3 id="download-and-install-needed-artifacts-optional">
<code>polkadot</code>, <code>polkadot-parachain</code>.
</p>
<p>For example:</p>
<pre><code class="language-bash">cd zombinet/javascript/packages && node ./cli/dist/cli.js setup polkadot polkadot-parachain
<pre><code class="language-bash">cd zombinet/javascript && npm i && npm run zombie -- setup polkadot polkadot-parachain
</code></pre>
<blockquote>
<p>
Expand Down Expand Up @@ -1733,18 +1733,30 @@ <h3 id="using-zombienet">
With the above steps completed, the <code>zombienet</code> CLI is
ready to run:
</p>
<pre><code class="language-bash"> cd zombinet/javascript/packages && node ./cli/dist/cli.js
<pre><code class="language-bash"> cd zombinet/javascript && npm run zombie

Usage: zombienet [options] [command]

Options:
-c, --spawn-concurrency &lt;concurrency&gt; Number of concurrent spawning process to launch,
default is 1
-p, --provider &lt;provider&gt; Override provider to use (choices: &quot;podman&quot;,
&quot;kubernetes&quot;, default: kubernetes)
-h, --help display help for command
&quot;kubernetes&quot;, &quot;native&quot;)
-l, --logType &lt;logType&gt; Type of logging - defaults to &quot;table&quot;
(choices: &quot;table&quot;, &quot;text&quot;, &quot;silent&quot;)
-d, --dir &lt;path&gt; Directory path for placing the network files instead of random temp one
(e.g. -d /home/user/my-zombienet)
-f, --force Force override all prompt commands
-h, --help Display help for command

Commands:
spawn &lt;networkConfig&gt; [creds] [monitor] Spawn the network defined in the config
test &lt;testFile&gt; Run tests on the network defined
spawn [options] &lt;networkConfig&gt; [creds] Spawn the network defined in the config
test &lt;testFile&gt; [runningNetworkSpec] Run tests on the network defined
setup [options] &lt;binaries...&gt; Setup is meant for downloading and making
dev environment of ZombieNet ready
convert &lt;filePath&gt; Convert is meant for transforming a
(now deprecated) polkadot-launch configuration
to zombienet configuration
version Prints zombienet version
help [command] display help for command
</code></pre>
Expand Down

0 comments on commit 3656fda

Please sign in to comment.