LBRYFoundation/LBRY-Vault
1
0
Fork 0
mirror of https://github.com/LBRYFoundation/LBRY-Vault.git synced 2025-09-03 12:30:07 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
LBRY Vault; LBRY Credits thin client
11449 commits 16 branches 124 tags 44 MiB
Find a file
ThomasV 9ec9e1760a CLI: always use the daemon's cmd_runner, and pass the 'wallet' 
parameter explicitly to each command that requires it.
Previous code was relying on side effects to set the wallet.
This should fix #5614
2019-09-05 17:57:51 +02:00
.github follow-up prev commit: use less space 2018-02-23 12:01:01 +01:00
contrib (trivial) wine build: rm keys in Dockerfile 2019-09-03 14:18:56 +02:00
electrum CLI: always use the daemon's cmd_runner, and pass the 'wallet' 2019-09-05 17:57:51 +02:00
pubkeys Decouple my GPG pubkey from Animazing 2019-05-02 14:23:31 +02:00
.gitignore Fix for onchain_history summary building 2019-09-02 16:24:08 +03:00
.gitmodules fix submodule 2019-09-04 12:39:02 +02:00
.travis.yml only build one android apk on Travis (take 3...) 2019-09-02 17:03:29 +02:00
AUTHORS Add self to AUTHORS 2015-11-09 22:53:27 +09:00
electrum-env Make sure bash can be found on *BSD 2019-07-28 07:08:56 +00:00
electrum.desktop Give visual feedback while starting (#4997) 2019-01-25 02:33:54 +01:00
LICENCE Relicensing 2016-02-24 10:20:30 +01:00
MANIFEST.in icons: instead of symlinks, just mv "icons" dir 2019-02-07 20:01:52 +01:00
README.rst README: mention submodule init 2019-09-04 14:03:39 +02:00
RELEASE-NOTES prepare release 3.3.8 2019-07-11 14:51:54 +02:00
run_electrum CLI: always use the daemon's cmd_runner, and pass the 'wallet' 2019-09-05 17:57:51 +02:00
setup.py add pycryptodomex to requirements 2019-08-20 09:03:11 +02:00
tox.ini tox: add python 3.7 to envlist 2018-09-20 18:25:46 +02:00

README.rst 

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

::

  Licence: MIT Licence
  Author: Thomas Voegtlin
  Language: Python (>= 3.6)
  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://d322cqt584bo4o.cloudfront.net/electrum/localized.svg
    :target: https://crowdin.com/project/electrum
    :alt: Help translate 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::

    ./run_electrum

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

    sudo apt-get install python3-setuptools
    python3 -m pip 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
    git submodule update --init

Run install (this should install dependencies)::

    python3 -m pip install .[fast]


Compile the protobuf description file::

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

Create translations (optional)::

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




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

Linux (tarball)
---------------

See :code:`contrib/build-linux/README.md`.


Linux (AppImage)
----------------

See :code:`contrib/build-linux/appimage/README.md`.


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

See :code:`contrib/osx/README.md`.


Windows
-------

See :code:`contrib/build-wine/README.md`.


Android
-------

See :code:`electrum/gui/kivy/Readme.md`.