tREADME.rst - electrum - Electrum Bitcoin wallet
HTML git clone https://git.parazyd.org/electrum
DIR Log
DIR Files
DIR Refs
DIR Submodules
---
tREADME.rst (3698B)
---
1 Electrum - Lightweight Bitcoin client
2 =====================================
3
4 ::
5
6 Licence: MIT Licence
7 Author: Thomas Voegtlin
8 Language: Python (>= 3.6)
9 Homepage: https://electrum.org/
10
11
12 .. image:: https://travis-ci.org/spesmilo/electrum.svg?branch=master
13 :target: https://travis-ci.org/spesmilo/electrum
14 :alt: Build Status
15 .. image:: https://coveralls.io/repos/github/spesmilo/electrum/badge.svg?branch=master
16 :target: https://coveralls.io/github/spesmilo/electrum?branch=master
17 :alt: Test coverage statistics
18 .. image:: https://d322cqt584bo4o.cloudfront.net/electrum/localized.svg
19 :target: https://crowdin.com/project/electrum
20 :alt: Help translate Electrum online
21
22
23
24
25
26 Getting started
27 ===============
28
29 (*If you've come here looking to simply run Electrum,* `you may download it here`_.)
30
31 .. _you may download it here: https://electrum.org/#download
32
33 Electrum itself is pure Python, and so are most of the required dependencies,
34 but not everything. The following sections describe how to run from source, but here
35 is a TL;DR::
36
37 sudo apt-get install libsecp256k1-0
38 python3 -m pip install --user .[gui,crypto]
39
40
41 Not pure-python dependencies
42 ----------------------------
43
44 If you want to use the Qt interface, install the Qt dependencies::
45
46 sudo apt-get install python3-pyqt5
47
48 For elliptic curve operations, `libsecp256k1`_ is a required dependency::
49
50 sudo apt-get install libsecp256k1-0
51
52 Alternatively, when running from a cloned repository, a script is provided to build
53 libsecp256k1 yourself::
54
55 sudo apt-get install automake libtool
56 ./contrib/make_libsecp256k1.sh
57
58 Due to the need for fast symmetric ciphers, `cryptography`_ is required.
59 Install from your package manager (or from pip)::
60
61 sudo apt-get install python3-cryptography
62
63
64 If you would like hardware wallet support, see `this`_.
65
66 .. _libsecp256k1: https://github.com/bitcoin-core/secp256k1
67 .. _pycryptodomex: https://github.com/Legrandin/pycryptodome
68 .. _cryptography: https://github.com/pyca/cryptography
69 .. _this: https://github.com/spesmilo/electrum-docs/blob/master/hardware-linux.rst
70
71 Running from tar.gz
72 -------------------
73
74 If you downloaded the official package (tar.gz), you can run
75 Electrum from its root directory without installing it on your
76 system; all the pure python dependencies are included in the 'packages'
77 directory. To run Electrum from its root directory, just do::
78
79 ./run_electrum
80
81 You can also install Electrum on your system, by running this command::
82
83 sudo apt-get install python3-setuptools python3-pip
84 python3 -m pip install --user .
85
86 This will download and install the Python dependencies used by
87 Electrum instead of using the 'packages' directory.
88 It will also place an executable named :code:`electrum` in :code:`~/.local/bin`,
89 so make sure that is on your :code:`PATH` variable.
90
91
92 Development version (git clone)
93 -------------------------------
94
95 Check out the code from GitHub::
96
97 git clone git://github.com/spesmilo/electrum.git
98 cd electrum
99 git submodule update --init
100
101 Run install (this should install dependencies)::
102
103 python3 -m pip install --user -e .
104
105
106 Create translations (optional)::
107
108 sudo apt-get install python-requests gettext
109 ./contrib/pull_locale
110
111 Finally, to start Electrum::
112
113 ./run_electrum
114
115
116
117 Creating Binaries
118 =================
119
120 Linux (tarball)
121 ---------------
122
123 See :code:`contrib/build-linux/sdist/README.md`.
124
125
126 Linux (AppImage)
127 ----------------
128
129 See :code:`contrib/build-linux/appimage/README.md`.
130
131
132 Mac OS X / macOS
133 ----------------
134
135 See :code:`contrib/osx/README.md`.
136
137
138 Windows
139 -------
140
141 See :code:`contrib/build-wine/README.md`.
142
143
144 Android
145 -------
146
147 See :code:`contrib/android/Readme.md`.