Skip to content

add note about running on windows #326

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/en/basic-install-all.md
Original file line number Diff line number Diff line change
@@ -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.

8 changes: 4 additions & 4 deletions docs/en/deploy-loom-testnet.md
Original file line number Diff line number Diff line change
@@ -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

2 changes: 2 additions & 0 deletions docs/en/deposit-and-withdraw-bep2.md
Original file line number Diff line number Diff line change
@@ -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:
7 changes: 7 additions & 0 deletions docs/en/deposit-and-withdraw-bnb.md
Original file line number Diff line number Diff line change
@@ -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:
7 changes: 7 additions & 0 deletions docs/en/deposit-and-withdraw-trx.md
Original file line number Diff line number Diff line change
@@ -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`:
16 changes: 11 additions & 5 deletions docs/en/extdev-transfer-gateway.md
Original file line number Diff line number Diff line change
@@ -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
7 changes: 7 additions & 0 deletions docs/en/how-to-develop-locally.md
Original file line number Diff line number Diff line change
@@ -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