Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
clifordsymack committed Sep 28, 2018
1 parent a644457 commit ecb3468
Showing 1 changed file with 9 additions and 23 deletions.
32 changes: 9 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,38 +6,24 @@ WARNING: THIS IS PRE-RELEASE SOFTWARE. This has been made available to provide f

## Installation

Ubuntu users can install using the following command. This command will install the latest version of Electron Cash with CashShuffle in your home directory.
For installation of plugin do the follows:

```
cd ~/ && wget https://electroncash.org/downloads/3.0/win-linux/ElectronCash-3.0.tar.gz && tar -xvzf ElectronCash-3.0.tar.gz && rm -rf ElectronCash-3.0.tar.gz && wget https://github.com/cashshuffle/cashshuffle-electron-cash-plugin/archive/master.zip && unzip master.zip && rm -rf master.zip && mv cashshuffle-electron-cash-plugin-master/shuffle 'Electron Cash-3.0/plugins' && rm -rf cashshuffle-electron-cash-plugin-master && sed -i "s/'electroncash_plugins.virtualkeyboard',/'electroncash_plugins.virtualkeyboard', 'electroncash_plugins.shuffle',/" 'Electron Cash-3.0/setup.py' && cd 'Electron Cash-3.0' && sudo python3 setup.py install
```

Otherwise, use the following instructions:

1. Place the `shuffle` folder `cashshuffle-electron-cash-plugin-master/shuffle` into the Electron Cash plugins folder `Electron Cash-3.0/plugins`
2. Open the `setup.py` file `Electron Cash-3.0/setup.py` and find the line that contains the text

```'electroncash_plugins.virtualkeyboard'```

Replace this text with

```'electroncash_plugins.virtualkeyboard', 'electroncash_plugins.shuffle',```
1. Download the latest release of the plugin (it should be a zip file) from [here](/releases).

3. `cd` into your Electron Cash directory, and re-install
2. Open Electron Cash.

```sudo python3 setup.py install```
3. Go to "Tools" | "Installed Plugins"

## Getting started
4. Click the "Add Plugin" button.

1. Enable the plugin by going to `Tools -> Plugins`
5. Select the plugin release you just downloaded.

![Settings](/images/settings.png)
6. Confirm that you understand the risks and dangers (do read the dialog, don't just blindly click through)

The shuffle tab will appear
7. Click "Install".

2. Close the settings dialog window. The shuffle tab will appear
8. Restart Electron Cash and you now should see the "Shuffle" tab in the main window.

![Server settings](/images/shuffle_tab.png)

## Making a shuffle

Expand Down

0 comments on commit ecb3468

Please sign in to comment.