LBRYFoundation/LBRY-Vault
1
0
Fork 0
mirror of https://github.com/LBRYFoundation/LBRY-Vault.git synced 2025-08-23 17:47:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

try to clean-up README

Browse source
This commit is contained in:
SomberNight 2020-03-04 20:05:18 +01:00
parent adc97af58c
commit 7e880427a2
No known key found for this signature in database
GPG key ID: B33B5F232C6271E9
1 changed files with 23 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
README.rst
View file

@ -26,7 +26,17 @@ Electrum - Lightweight Bitcoin client
Getting started
===============
Electrum itself is pure Python, and so are most of the required dependencies.
(*If you've come here looking to simply run Electrum,* `you may download it here`_.)
.. _you may download it here: https://electrum.org/#download
Electrum itself is pure Python, and so are most of the required dependencies,
but not everything. The following sections describe how to run from source, but here
is a TL;DR::
sudo apt-get install libsecp256k1-0
python3 -m pip install --user .[gui,crypto]
Not pure-python dependencies
----------------------------
@ -35,7 +45,7 @@ If you want to use the Qt interface, install the Qt dependencies::
sudo apt-get install python3-pyqt5
For elliptic curve operations, libsecp256k1 is a required dependency::
For elliptic curve operations, `libsecp256k1`_ is a required dependency::
sudo apt-get install libsecp256k1-0
@ -44,13 +54,20 @@ libsecp256k1 yourself::
./contrib/make_libsecp256k1.sh
Due to the need for fast symmetric ciphers, either one of :code:`pycryptodomex`
or :code:`cryptography` is required. Install from your package manager
Due to the need for fast symmetric ciphers, either one of `pycryptodomex`_
or `cryptography`_ is required. Install from your package manager
(or from pip)::
sudo apt-get install python3-cryptography
If you would like hardware wallet support, see `this`_.
.. _libsecp256k1: https://github.com/bitcoin-core/secp256k1
.. _pycryptodomex: https://github.com/Legrandin/pycryptodome
.. _cryptography: https://github.com/pyca/cryptography
.. _this: https://github.com/spesmilo/electrum-docs/blob/master/hardware-linux.rst
Running from tar.gz
-------------------
@ -69,13 +86,9 @@ You can also install Electrum on your system, by running this command::
This will download and install the Python dependencies used by
Electrum instead of using the 'packages' directory.
If you cloned the git repository, you need to compile extra files
before you can run Electrum. Read the next section, "Development
version".
Development version
-------------------
Development version (git clone)
-------------------------------
Check out the code from GitHub::