-WIP-electrum-btcp/README.rst

122 lines
2.5 KiB
ReStructuredText
Raw Normal View History

2016-03-05 22:44:10 -08:00
Electrum - Lightweight Bitcoin client
2015-06-27 00:58:45 -07:00
=====================================
::
2016-02-23 02:36:42 -08:00
Licence: MIT Licence
2015-06-27 00:58:45 -07:00
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
2016-03-05 22:44:10 -08:00
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::
2016-03-18 01:20:00 -07:00
sudo apt-get install python-qt4
2016-03-05 22:44:10 -08:00
If you downloaded the official package (tar.gz), then you can run
Electrum from its root directory, without installing it on your
2016-03-18 01:20:00 -07:00
system; all the python dependencies are included in the 'packages'
directory. To run Electrum from its root directory, just do::
2015-06-27 00:58:45 -07:00
./electrum
2016-03-05 22:44:10 -08:00
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
2016-03-17 04:52:40 -07:00
Run install (this should install dependencies)::
python setup.py install
2016-03-05 22:44:10 -08:00
Compile the icons file for Qt::
sudo apt-get install pyqt4-dev-tools
2016-03-18 01:08:15 -07:00
pyrcc4 icons.qrc -o gui/qt/icons_rc.py
2016-03-05 22:44:10 -08:00
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
========================
2015-06-27 00:58:45 -07:00
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
2016-03-05 22:44:10 -08:00
Creating Binaries
=================
2015-06-27 00:58:45 -07:00
In order to create binaries, you must create the 'packages' directory::
2015-06-27 00:58:45 -07:00
2016-03-17 04:52:40 -07:00
./contrib/make_packages
2015-06-27 00:58:45 -07:00
2016-03-18 01:20:00 -07:00
This directory contains the python dependencies used by Electrum.
2016-03-05 22:44:10 -08:00
Mac OS X
--------
2015-06-27 00:58:45 -07:00
2016-04-17 10:59:18 -07:00
::
2015-06-27 00:58:45 -07:00
2016-04-17 10:59:18 -07:00
# On MacPorts installs:
sudo python setup-release.py py2app
# On Homebrew installs:
2015-06-27 00:58:45 -07:00
ARCHFLAGS="-arch i386 -arch x86_64" sudo python setup-release.py py2app --includes sip
2016-04-17 10:59:18 -07:00
2015-06-27 00:58:45 -07:00
sudo hdiutil create -fs HFS+ -volname "Electrum" -srcfolder dist/Electrum.app dist/electrum-VERSION-macosx.dmg
2016-03-05 22:44:10 -08:00
Windows
-------
2016-04-17 10:59:18 -07:00
See `contrib/build-wine/README` file.
2016-03-05 22:44:10 -08:00
Android
-------
2016-04-17 10:59:18 -07:00
See `gui/kivy/Readme.txt` file.