Go to file
ThomasV 7e39052c59 kivy: fix 2016-03-17 11:13:18 +01:00
contrib Forget to readd this part 2016-03-09 19:58:43 +01:00
gui kivy: fix 2016-03-17 11:13:18 +01:00
icons rm unused icon file 2016-01-26 13:52:19 +01:00
lib version 2.6.3, release notes 2016-03-16 20:42:27 +01:00
plugins trustedcoin: fix get_max_amount 2016-03-07 06:38:52 +01:00
pubkeys
scripts rm authenticator script (replaced by new android app 2016-02-15 16:25:59 +01:00
.gitignore kivy:Improve startup speed 2016-01-27 20:21:20 +05:30
.travis.yml travis: use Tox for test automation 2015-07-02 17:25:02 +03:00
AUTHORS Add self to AUTHORS 2015-11-09 22:53:27 +09:00
Info.plist
LICENCE Relicensing 2016-02-24 10:20:30 +01:00
MANIFEST.in remove themes, check python3 in setup.py 2015-10-18 12:43:20 +02:00
README.rst add build instuctions to README 2016-03-06 07:44:10 +01:00
RELEASE-NOTES version 2.6.3, release notes 2016-03-16 20:42:27 +01:00
app.fil update app.fil with kivy strings 2016-02-04 11:49:48 +01:00
electrum set KIVY_DATA_DIR in main script 2016-03-08 04:55:58 +01:00
electrum-env kivy:Improve startup speed 2016-01-27 20:21:20 +05:30
electrum.conf.sample
electrum.desktop
electrum.icns
icons.qrc Update icons.qrc 2016-01-28 07:10:13 +07:00
setup-release.py add packages directory to osx setup 2015-08-18 17:36:22 +02:00
setup.py Fix installation when --root is specified 2016-02-29 13:28:18 +01:00
tox.ini travis: use Tox for test automation 2015-07-02 17:25:02 +03:00

README.rst

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





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

Electrum is a pure python application. However, if you want to use the
Qt interface, then you need to install the Qt dependencies::

    sudo apt-get install python-pip python-qt4


If you downloaded the official package (tar.gz), then you can run
Electrum from its root directory, without installing it on your
system. To run Electrum from this directory, just do::

    ./electrum

If you cloned the git repository, then 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

Compile the icons file for Qt::

    sudo apt-get install pyqt4-dev-tools
    pyrcc4 icons.qrc -o gui/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::

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



Install on Linux systems
========================

If you install Electrum on your system, you can run it from any
directory.

If you have pip, you can do::

    python setup.py sdist
    sudo pip install --pre dist/Electrum-2.0.tar.gz


If you don't have pip, install with::

    python setup.py sdist
    sudo python setup.py install



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


In oder to creating binaries, you must create the 'packages' directory::

    ./contrib/pake_packages


Mac OS X
--------

    # On port based installs
    sudo python setup-release.py py2app

    # On brew installs
    ARCHFLAGS="-arch i386 -arch x86_64" sudo python setup-release.py py2app --includes sip

    sudo hdiutil create -fs HFS+ -volname "Electrum" -srcfolder dist/Electrum.app dist/electrum-VERSION-macosx.dmg


Windows
-------

see contrib/build-wine/README


Android
-------

see gui/kivy/Readme.txt