electrum

ThomasV dc8bedd75b trustedcoin: fix get_max_amount		10 years ago
contrib	kivy: fix regression	10 years ago
gui	kivy: fix regression	10 years ago
icons	rm unused icon file	10 years ago
lib	fix bug in interface.get_responses	10 years ago
plugins	trustedcoin: fix get_max_amount	10 years ago
pubkeys	Add my own public key.	11 years ago
scripts	rm authenticator script (replaced by new android app	10 years ago
.gitignore	kivy:Improve startup speed	10 years ago
.travis.yml	travis: use Tox for test automation	11 years ago
AUTHORS	Add self to AUTHORS	10 years ago
Info.plist	Removed packages folder as depedency for osx builds	11 years ago
LICENCE	Relicensing	10 years ago
MANIFEST.in	remove themes, check python3 in setup.py	10 years ago
README.rst	add build instuctions to README	10 years ago
RELEASE-NOTES	trustedcoin: fix get_max_amount	10 years ago
app.fil	update app.fil with kivy strings	10 years ago
electrum	add import for pyinstaller	10 years ago
electrum-env	kivy:Improve startup speed	10 years ago
electrum.conf.sample	more settings and comments	13 years ago
electrum.desktop	Icon location fix. Fixes #1111	11 years ago
electrum.icns	New app icons	12 years ago
icons.qrc	Update icons.qrc	10 years ago
setup-release.py	add packages directory to osx setup	10 years ago
setup.py	Fix installation when --root is specified	10 years ago
tox.ini	travis: use Tox for test automation	11 years ago

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