Fixed wrong link to semaphore-base.circom in docs (#37)

* fixed wrong link to semaphore-base.circom in docs

* updated the docs build script to not delete CNAME; fixed some minor errors in the tutorial

* added warning about compiling scrypt in node 12

* added warning about lerna

Former-commit-id: 1e34d21

.gitignore

@@ -1,3 +1,4 @@
+CNAME
 docs_src/book/
 .etherlime-store
 **/build/

docs/print.html

@@ -348,29 +348,33 @@ <h2><a class="header" href="#cryptographic-primitives" id="cryptographic-primiti
 circuits and EVM bytecode generator have not been audited, so use it with
 caution. To use it, checkout the <code>feat/poseidon</code> branch of this repository.</p>
 <h1><a class="header" href="#quick-start" id="quick-start">Quick start</a></h1>
-<p>Semaphore has been tested with Node 11.14.0 and Node 12 LTE. Use
-<a href="https://github.com/nvm-sh/nvm"><code>nvm</code></a> to manage your Node version.</p>
+<p>Semaphore has been tested with Node 11.14.0. It will run with Node 12 LTE but
+we highly recommend using Node 11.14.0 if you wish to develop on its source
+code, as one of its dependencies, <code>script</code>, cannot compile when if you use Node
+12. </p>
+<p>Use <a href="https://github.com/nvm-sh/nvm"><code>nvm</code></a> to manage your Node version.</p>
 <p>Clone this repository, install dependencies, and build the source code:</p>
 <pre><code class="language-bash">git clone [email protected]:kobigurk/semaphore.git &amp;&amp; \
 cd semaphore &amp;&amp; \
 npm i &amp;&amp; \
 npm run bootstrap &amp;&amp; \
 npm run build
 </code></pre>
+<p><strong>Note</strong>: we use <code>lerna</code> to manage the <code>circuits</code>, <code>config</code>, and <code>contracts</code>
+subpackages. Do not run <code>npm install</code> within any of these directories. Instead,
+just run <code>npm run bootstrap</code> in the main directory.</p>
 <p>Next, either download the compiled zk-SNARK circuit, proving key, and
 verification key (note that these keys are for testing purposes, and not for
 production, as there is no certainty that the toxic waste was securely
 discarded).</p>
 <p>To download the circuit, proving key, and verification key, run:</p>
 <pre><code class="language-bash"># Start from the base directory
 
-cd circuits &amp;&amp; \
 ./circuits/scripts/download_snarks.sh
 </code></pre>
 <p>To generate the above files locally instead, run:</p>
 <pre><code class="language-bash"># Start from the base directory
 
-cd circuits &amp;&amp; \
 ./circuits/scripts/build_snarks.sh
 </code></pre>
 <p>This process should take about 45 minutes.</p>

docs/quickstart.html

@@ -149,29 +149,33 @@ <h1 class="menu-title"></h1>
                 <div id="content" class="content">
                     <main>
                         <h1><a class="header" href="#quick-start" id="quick-start">Quick start</a></h1>
-<p>Semaphore has been tested with Node 11.14.0 and Node 12 LTE. Use
-<a href="https://github.com/nvm-sh/nvm"><code>nvm</code></a> to manage your Node version.</p>
+<p>Semaphore has been tested with Node 11.14.0. It will run with Node 12 LTE but
+we highly recommend using Node 11.14.0 if you wish to develop on its source
+code, as one of its dependencies, <code>script</code>, cannot compile when if you use Node
+12. </p>
+<p>Use <a href="https://github.com/nvm-sh/nvm"><code>nvm</code></a> to manage your Node version.</p>
 <p>Clone this repository, install dependencies, and build the source code:</p>
 <pre><code class="language-bash">git clone [email protected]:kobigurk/semaphore.git &amp;&amp; \
 cd semaphore &amp;&amp; \
 npm i &amp;&amp; \
 npm run bootstrap &amp;&amp; \
 npm run build
 </code></pre>
+<p><strong>Note</strong>: we use <code>lerna</code> to manage the <code>circuits</code>, <code>config</code>, and <code>contracts</code>
+subpackages. Do not run <code>npm install</code> within any of these directories. Instead,
+just run <code>npm run bootstrap</code> in the main directory.</p>
 <p>Next, either download the compiled zk-SNARK circuit, proving key, and
 verification key (note that these keys are for testing purposes, and not for
 production, as there is no certainty that the toxic waste was securely
 discarded).</p>
 <p>To download the circuit, proving key, and verification key, run:</p>
 <pre><code class="language-bash"># Start from the base directory
 
-cd circuits &amp;&amp; \
 ./circuits/scripts/download_snarks.sh
 </code></pre>
 <p>To generate the above files locally instead, run:</p>
 <pre><code class="language-bash"># Start from the base directory
 
-cd circuits &amp;&amp; \
 ./circuits/scripts/build_snarks.sh
 </code></pre>
 <p>This process should take about 45 minutes.</p>

docs_src/build.sh

@@ -3,4 +3,12 @@
 cd "$(dirname "$0")"
 mkdir -p ../docs
 
+if [ -f ../docs/CNAME ]; then
+    mv ../docs/CNAME ./CNAME_bak
+fi
+
 mdbook build . --dest-dir ../docs/ 
+
+if [ -f ./CNAME ]; then
+    mv ./CNAME_bak ../docs/
+fi

docs_src/src/quickstart.md

@@ -1,7 +1,11 @@
 # Quick start
 
-Semaphore has been tested with Node 11.14.0 and Node 12 LTE. Use
-[`nvm`](https://github.com/nvm-sh/nvm) to manage your Node version.
+Semaphore has been tested with Node 11.14.0. It will run with Node 12 LTE but
+we highly recommend using Node 11.14.0 if you wish to develop on its source
+code, as one of its dependencies, `script`, cannot compile when if you use Node
+12. 
+
+Use [`nvm`](https://github.com/nvm-sh/nvm) to manage your Node version.
 
 Clone this repository, install dependencies, and build the source code:
 
@@ -13,6 +17,10 @@ npm run bootstrap && \
 npm run build
 ```
 
+**Note**: we use `lerna` to manage the `circuits`, `config`, and `contracts`
+subpackages. Do not run `npm install` within any of these directories. Instead,
+just run `npm run bootstrap` in the main directory.
+
 Next, either download the compiled zk-SNARK circuit, proving key, and
 verification key (note that these keys are for testing purposes, and not for
 production, as there is no certainty that the toxic waste was securely
@@ -23,7 +31,6 @@ To download the circuit, proving key, and verification key, run:
 ```bash
 # Start from the base directory
 
-cd circuits && \
 ./circuits/scripts/download_snarks.sh
 ```
 
@@ -32,7 +39,6 @@ To generate the above files locally instead, run:
 ```bash
 # Start from the base directory
 
-cd circuits && \
 ./circuits/scripts/build_snarks.sh
 ```