commit dbe17744c011c340a56371b49a0fe7724953bb81
parent e6bec51a7653c03854a727c7f261431165b6a5e7
Author: chris-belcher <chris-belcher@users.noreply.github.com>
Date: Tue, 2 Oct 2018 00:57:31 +0100
Restore old readme file until next version release
Many people read the README from the github web page so we
want the instructions to be accurate for the latest release
Diffstat:
2 files changed, 6 insertions(+), 28 deletions(-)
diff --git a/README.md b/README-pip.md
diff --git a/README.md b/README.md
@@ -60,16 +60,11 @@ and `[watch-only-addresses]` sections. Master public keys for an Electrum wallet
(which start with xpub/ypub/zpub) can be found in the Electrum client menu
`Wallet` -> `Information`.
-* Install Electrum Personal Server in your home directory with
- `pip3 install --user .`. On Linux the scripts
- (`electrum-personal-server` and `electrum-personal-server-rescan`) will be
- installed in `~/.local/bin`.
-
-* Run `electrum-personal-server -c /path/to/config.cfg` to start Electrum
- Personal Server. The first time the server is run it will import all
- configured addresses as watch-only into the Bitcoin node, and then exit.
- If the wallets contain historical transactions you can use the rescan script
- (`electrum-personal-server-rescan -c /path/to/config.cfg`) to make them appear.
+* Run `./server.py` on Linux or double-click `run-server.bat` on Windows.
+The first time the server is run it will import all configured addresses as
+watch-only into the Bitcoin node, and then exit. If the wallets contain
+historical transactions you can use the rescan script (`./rescan-script.py` or
+`rescan-script.bat`) to make them appear.
* Run the server again which will start Electrum Personal Server. Tell Electrum
wallet to connect to it in `Tools` -> `Server`. By default the server details
@@ -160,18 +155,6 @@ I can be contacted on freenode IRC on the `#bitcoin` and `#electrum` channels, b
My PGP key fingerprint is: `0A8B 038F 5E10 CC27 89BF CFFF EF73 4EA6 77F3 1129`.
-### Notes for developers
-
-To seamlessly work on the codebase while using `pip`, you need to
-install in the `develop`/`editable` mode. You can do that with:
-
- $ pip3 install --user -e /path/to/repo
-
-`/path/to/repo` can also be a relative path, so if you are in the
-source directory, just use `.`. This installs the scripts in the
-usual places, but imports the package from the source directory. This
-way, any changes you make are immediately visible.
-
#### Testing
Electrum Personal Server also works on [testnet](https://en.bitcoin.it/wiki/Testnet)
@@ -179,7 +162,7 @@ and [regtest](https://bitcoin.org/en/glossary/regression-test-mode). The
Electrum wallet can be started in testnet mode with the command line flag
`--testnet` or `--regtest`.
-pytest is used for automated testing. On Debian-like systems install with
+pytest is used for automated testing. On Debian-like systems install with
`pip3 install pytest pytest-cov`
Run the tests with:
@@ -191,11 +174,6 @@ Create the coverage report with:
$ PYTHONPATH=.:$PYTHONPATH py.test-3 --cov-report=html --cov
$ open htmlcov/index.html
-If you have installed Electrum Personal Server with pip, there is no
-need to set `PYTHONPATH`. You could also run the tests with:
-
- $ python3 setup.py test
-
## Media Coverage
* https://bitcoinmagazine.com/articles/electrum-personal-server-will-give-users-full-node-security-they-need/
