Skip to content
This repository has been archived by the owner on Feb 26, 2021. It is now read-only.

Update README.md #578

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
60 changes: 33 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,35 @@
# IOTA App
# IOTA Wallet

## Prerequisites
IOTA is a distributed ledger protocol. No fees on transactions and no fixed limit to load on transaction confirmations. The more activity, the faster the network.

1. Download [NodeJS](https://nodejs.org/en/download/)
## Download wallet

2. Install [Electron](http://electron.atom.io):
You can download the latest wallet software from https://github.com/iotaledger/wallet/releases. Go to the download section for the latest release and find the respective version for your operating system. For Mac users its the `.dmg` file and for Windows users its the `.exe` file.

```
npm install -g electron
```
## Compile from source

3. Install [Bower](https://bower.io/):
If your are interested in the development please follow these steps to compile from source:

```
npm install -g bower
```
### Prerequisites

#### Windows Users Only
1. Download [NodeJS](https://nodejs.org/en/download/)

Run the following command as Administrator:
2. Install [Electron](http://electron.atom.io) and [Bower](https://bower.io/):

```
npm install -g --production windows-build-tools
npm install -g electron bower
```

#### Compiling

If you wish to compile the app, install the following also:
##### For Windows Users Only

1. Install [Electron Builder](https://github.com/electron-userland/electron-builder)
Please Run the following command as Administrator:

Electron Builder is used behind the scenes. Read their [instructions](https://github.com/electron-userland/electron-builder/wiki/Multi-Platform-Build) on how to set up your system.
```
npm install -g --production windows-build-tools
```

2. Install [Docker](https://www.docker.com)

## Instructions
### Instructions

1. Clone this repository:

Expand Down Expand Up @@ -67,23 +62,34 @@ If you wish to compile the app, install the following also:
```
npm start
```

## Testnet

To build for the testnet, please rename `package.testnet.json` to `package.json` and follow same instructions as normal, but make sure the jar is named `iri-testnet.jar`.


## Compiling

If you wish to compile the app after building from source, please follow these

1. Make sure you have [Electron Builder](https://github.com/electron-userland/electron-builder) Installed. Electron Builder is used behind the scenes. Read their [instructions](https://github.com/electron-userland/electron-builder/wiki/Multi-Platform-Build) on how to set up your system.

6. If you wish to compile the app:
2. Make sure you have [Docker](https://www.docker.com) installed.


3. When you wish to compile the app:

```
npm run compile
```

If you'd like to create a package only for a specific OS, you can do so like this:
Compiled binaries are found in the `out` directory.
If you'd like to create a package only for a specific OS, you can do so with:

```
npm run compile:win
npm run compile:mac
npm run compile:lin
```

Compiled binaries are found in the `out` directory.

#### Testnet

To build testnet binaries, rename `package.testnet.json` to `package.json` and follow instructions as above. Make sure the jar is named `iri-testnet.jar`.