diff --git a/docs/en/basic-install-all.md b/docs/en/basic-install-all.md index 28da7a93e..e07cb8e10 100644 --- a/docs/en/basic-install-all.md +++ b/docs/en/basic-install-all.md @@ -8,9 +8,13 @@ sidebar_label: Setup Local Loom Chain The purpose of this document is to walk you through the process of setting up a local Loom Chain. This step is _**not required for deploying to Loom Testnet or Loom Mainnet**_, but we've included it because some people might find it useful. Say, for example, you're offline for large amounts of time. Why wouldn't you want to use that time do some dev work? So, for those of you considering working offline, this document will provide the necessary details. -# Installing and setting up Loom +## Requirements + +Make sure the following requirements are met and then follow the steps in the next section: -Currently the only way to use Loom on Windows is to use the [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10).1 +- Operating system: Linux or macOS. If you're running Windows, please install the Windows Subsystem for Linux. See the [Install the Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10) page for details on installing WSL. + +# Installing and setting up Loom Once you install that, you can continue with the below sections. diff --git a/docs/en/deploy-loom-testnet.md b/docs/en/deploy-loom-testnet.md index 59bf85904..fc3e59c1d 100644 --- a/docs/en/deploy-loom-testnet.md +++ b/docs/en/deploy-loom-testnet.md @@ -22,10 +22,10 @@ This document shows how you can use `Truffle` and the [Loom Truffle Provider](ht Make sure the following requirements are met and then follow the steps in the next section: -```text -Node >= 8 -yarn or npm -``` +- Operating system: Linux or macOS. If you're running Windows, please install the Windows Subsystem for Linux. See the [Install the Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10) page for details on installing WSL. +- Node >= 8 +- yarn + ## Setting Things Up diff --git a/docs/en/deposit-and-withdraw-bep2.md b/docs/en/deposit-and-withdraw-bep2.md index 2de286fe7..f0ae2d6e7 100644 --- a/docs/en/deposit-and-withdraw-bep2.md +++ b/docs/en/deposit-and-withdraw-bep2.md @@ -21,6 +21,8 @@ Let's get the ball rolling! ## Prerequisites +- Operating system: Linux or macOS. If you're running Windows, please install the Windows Subsystem for Linux. See the [Install the Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10) page for details on installing WSL. + - Node.js 10 or higher (recommended v10.15.3) To check out if Node.js is installed on your computer, fire up a terminal and type the following command: diff --git a/docs/en/deposit-and-withdraw-bnb.md b/docs/en/deposit-and-withdraw-bnb.md index 12dd3f3e1..0a181baa6 100644 --- a/docs/en/deposit-and-withdraw-bnb.md +++ b/docs/en/deposit-and-withdraw-bnb.md @@ -9,6 +9,13 @@ Loom’s PlasmaChain has recently integrated with Binance Chain, which means use This guide walks you through the basics of building a simple web app that lets users deposit and withdraw BNB between Binance Testnet and Loom Testnet. +## Requirements + +Make sure the following requirements are met and then follow the steps in the next section: + +- Operating system: Linux or macOS. If you're running Windows, please install the Windows Subsystem for Linux. See the [Install the Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10) page for details on installing WSL. +- Node.js 10 or higher (recommended v10.15.3) + ## Getting Started The first thing we would want to do is to import a few things: diff --git a/docs/en/deposit-and-withdraw-trx.md b/docs/en/deposit-and-withdraw-trx.md index 2896fdf58..2c753abb0 100644 --- a/docs/en/deposit-and-withdraw-trx.md +++ b/docs/en/deposit-and-withdraw-trx.md @@ -7,6 +7,13 @@ Loom’s PlasmaChain is integrated with TRON, which means TRON developers can di This guide walks you through the basics of building a simple web app that lets users deposit and withdraw TRX between Shasta and Loom Testnet. +## Requirements + +Make sure the following requirements are met and then follow the steps in the next section: + +- Operating system: Linux or macOS. If you're running Windows, please install the Windows Subsystem for Linux. See the [Install the Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10) page for details on installing WSL. +- Node.js 10 or higher (recommended v10.15.3) + ## Getting Started [TronWeb](https://developers.tron.network/docs/tron-web-intro) is a Javascript library that enables web apps to "talk" with the TRON blockchain. So, the first thing we would want to do is to install `Tron-Web`: diff --git a/docs/en/extdev-transfer-gateway.md b/docs/en/extdev-transfer-gateway.md index 3d5cb40ca..84445e0cf 100644 --- a/docs/en/extdev-transfer-gateway.md +++ b/docs/en/extdev-transfer-gateway.md @@ -8,6 +8,14 @@ sidebar_label: Transfer Gateway Testnet In this doc, we'll walk you through the setup required to transfer tokens between token contracts you've deployed to `extdev` and `Rinkeby`. If you haven't done so already you should first read through the high-level overview of the [Transfer Gateway][]. +## Requirements + +Make sure the following requirements are met and then follow the steps in the next section: + +- Operating system: Linux or macOS. If you're running Windows, please install the Windows Subsystem for Linux. See the [Install the Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10) page for details on installing WSL. +- Node >= 8 +- yarn + ## 1. Deploy token contracts to `extdev` @@ -77,9 +85,7 @@ Full source for all contracts can be found in the [Truffle DAppChain Example][] export LOOM_BIN=`pwd`/loom ``` -2. Make sure you have `node` (v8 or later) and `yarn` installed. - -3. Clone the [Truffle DAppChain Example][] repo. +2. Clone the [Truffle DAppChain Example][] repo. ```bash # clone the tutorial repo to the gateway-tutorial directory @@ -89,7 +95,7 @@ Full source for all contracts can be found in the [Truffle DAppChain Example][] yarn ``` -4. Generate your own private key for deploying and calling contracts on the `extdev` PlasmaChain. +3. Generate your own private key for deploying and calling contracts on the `extdev` PlasmaChain. ```bash $LOOM_BIN genkey -k extdev_private_key -a extdev_public_key @@ -104,7 +110,7 @@ Full source for all contracts can be found in the [Truffle DAppChain Example][] This is the public address that corresponds to your new private key. You'll find the private key in the `extdev_private_key` file, and the corresponding public key in the `extdev_public_key` file. -5. Deploy the `MyToken` and `MyCoin` contracts to the `extdev` PlasmaChain. +4. Deploy the `MyToken` and `MyCoin` contracts to the `extdev` PlasmaChain. ```bash yarn deploy:extdev diff --git a/docs/en/how-to-develop-locally.md b/docs/en/how-to-develop-locally.md index b0de91d76..acaa4e3a4 100644 --- a/docs/en/how-to-develop-locally.md +++ b/docs/en/how-to-develop-locally.md @@ -8,6 +8,13 @@ sidebar_label: Develop Locally This document shows you how to develop and test your smart contracts locally against Ganache and Loom. +## Requirements + +Make sure the following requirements are met and then follow the steps in the next section: + +- Operating system: Linux or macOS. If you're running Windows, please install the Windows Subsystem for Linux. See the [Install the Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10) page for details on installing WSL. +- Node.js 10 or higher (recommended v10.15.3) + ## Develop Locally Against Ganache ### Install Truffle