You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

111 lines
2.3 KiB

Electrum - Lightweight Bitcoin client
=====================================
::
9 years ago
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. If you want to use the
Qt interface, install the Qt dependencies::
9 years ago
sudo apt-get install python-qt4
If you downloaded the official package (tar.gz), you can run
Electrum from its root directory, without installing it on your
9 years ago
system; all the python dependencies are included in the 'packages'
directory. To run Electrum from its root directory, just do::
./electrum
8 years ago
You can also install Electrum on your system, by running this command::
python setup.py install
This will download and install the Python dependencies used by
Electrum, instead of using the 'packages' directory.
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
9 years ago
Run install (this should install dependencies)::
python setup.py install
Compile the icons file for Qt::
sudo apt-get install pyqt4-dev-tools
9 years ago
pyrcc4 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
8 years ago
Create translations (optional)::
sudo apt-get install python-pycurl gettext
./contrib/make_locale
Creating Binaries
=================
To create binaries, create the 'packages' directory::
9 years ago
./contrib/make_packages
9 years ago
This directory contains the python dependencies used by Electrum.
Mac OS X
--------
::
# On MacPorts installs:
sudo python setup-release.py py2app
# On Homebrew 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` file.
Android
-------
See `gui/kivy/Readme.txt` file.