LBRY Vault; LBRY Credits thin client
Find a file
2018-06-30 13:22:46 +02:00
.github follow-up prev commit: use less space 2018-02-23 12:01:01 +01:00
contrib winbuilds: update README. Do not sign in unsign.sh 2018-06-30 13:22:46 +02:00
gui read apk version number from version.py 2018-06-29 10:45:34 +02:00
icons Fill unconfirmed icon white 2018-06-26 19:40:38 +02:00
lib labels plugin: fix it. and extend to cli/daemon. 2018-06-29 11:58:12 +02:00
plugins labels plugin: fix it. and extend to cli/daemon. 2018-06-29 11:58:12 +02:00
pubkeys Add my public key 2018-02-11 15:28:01 +01:00
scripts Remove explicit send calls, part deux (#4408) 2018-06-06 15:06:04 +02:00
snap updated snap packaging details 2017-10-20 23:23:32 +02:00
.gitignore Find files to translate automatically 2018-03-09 19:15:05 +01:00
.gitmodules Track icons and locale version in submodule 2018-05-13 22:06:25 +02:00
.travis.yml travis builds windows binaries in docker 2018-06-29 22:49:59 +02:00
AUTHORS Add self to AUTHORS 2015-11-09 22:53:27 +09:00
electrum add simnet support (#4455) 2018-06-22 17:07:07 +02:00
electrum-env electrum-env: run from script's dir 2018-03-27 22:21:07 +03:00
electrum.conf.sample Fix typos 2018-04-15 20:34:40 +02:00
electrum.desktop Fix typos 2018-04-15 20:34:40 +02:00
electrum.icns Updated mac icon to meet aesthetic of Windows icon 2017-07-25 00:03:36 -07:00
icons.qrc show address on hw: change icon 2018-04-28 16:07:49 +02:00
Info.plist Revert "follow-up f7200cb616: remove Info.plist" 2017-11-06 19:04:07 +01:00
LICENCE Relicensing 2016-02-24 10:20:30 +01:00
MANIFEST.in Find files to translate automatically 2018-03-09 19:15:05 +01:00
README.rst README: reference 'fast' extra instead of 'full' 2018-06-15 13:07:10 +02:00
RELEASE-NOTES add code name for version 3.2 2018-06-29 12:44:25 +02:00
setup.py python3.4: typing module is not part of stdlib 2018-06-16 17:38:30 +02:00
tox.ini use libsecp256k1 if available. abstract away ecc stuff. move symmetric crypto and hash functions to crypto.py 2018-05-25 15:43:06 +02:00

Electrum - Lightweight Bitcoin client
=====================================

::

  Licence: MIT Licence
  Author: Thomas Voegtlin
  Language: Python
  Homepage: https://electrum.org/


.. image:: https://travis-ci.org/spesmilo/electrum.svg?branch=master
    :target: https://travis-ci.org/spesmilo/electrum
    :alt: Build Status
.. image:: https://coveralls.io/repos/github/spesmilo/electrum/badge.svg?branch=master
    :target: https://coveralls.io/github/spesmilo/electrum?branch=master
    :alt: Test coverage statistics
.. image:: https://img.shields.io/badge/help-translating-blue.svg
    :target: https://crowdin.com/project/electrum
    :alt: Help translating Electrum online





Getting started
===============

Electrum is a pure python application. If you want to use the
Qt interface, install the Qt dependencies::

    sudo apt-get install python3-pyqt5

If you downloaded the official package (tar.gz), you can run
Electrum from its root directory, without installing it on your
system; all the python dependencies are included in the 'packages'
directory. To run Electrum from its root directory, just do::

    ./electrum

You can also install Electrum on your system, by running this command::

    sudo apt-get install python3-setuptools
    pip3 install .[fast]

This will download and install the Python dependencies used by
Electrum, instead of using the 'packages' directory.
The 'fast' extra contains some optional dependencies that we think
are often useful but they are not strictly needed.

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
===================

Check out the code from GitHub::

    git clone git://github.com/spesmilo/electrum.git
    cd electrum

Run install (this should install dependencies)::

    pip3 install .[fast]

Render the SVG icons to PNGs (optional)::

    for i in lock unlock confirmed status_lagging status_disconnected status_connected_proxy status_connected status_waiting preferences; do convert -background none icons/$i.svg icons/$i.png; done

Compile the icons file for Qt::

    sudo apt-get install pyqt5-dev-tools
    pyrcc5 icons.qrc -o gui/qt/icons_rc.py

Compile the protobuf description file::

    sudo apt-get install protobuf-compiler
    protoc --proto_path=lib/ --python_out=lib/ lib/paymentrequest.proto

Create translations (optional)::

    sudo apt-get install python-requests gettext
    ./contrib/make_locale




Creating Binaries
=================


To create binaries, create the 'packages' directory::

    ./contrib/make_packages

This directory contains the python dependencies used by Electrum.

Mac OS X / macOS
--------

See `contrib/build-osx/`.

Windows
-------

See `contrib/build-wine/`.


Android
-------

See `gui/kivy/Readme.txt` file.