add build instuctions to README
This commit is contained in:
parent
a0b861cd8f
commit
1af48b3769
79
README.rst
79
README.rst
|
@ -1,4 +1,4 @@
|
|||
Electrum - lightweight Bitcoin client
|
||||
Electrum - Lightweight Bitcoin client
|
||||
=====================================
|
||||
|
||||
::
|
||||
|
@ -14,13 +14,58 @@ Electrum - lightweight Bitcoin client
|
|||
:alt: Build Status
|
||||
|
||||
|
||||
1. GETTING STARTED
|
||||
------------------
|
||||
|
||||
To run Electrum from this directory, just do::
|
||||
|
||||
|
||||
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.
|
||||
|
||||
|
@ -37,15 +82,17 @@ If you don't have pip, install with::
|
|||
|
||||
|
||||
|
||||
2. HOW OFFICIAL PACKAGES ARE CREATED
|
||||
------------------------------------
|
||||
Creating Binaries
|
||||
=================
|
||||
|
||||
On Linux/Windows::
|
||||
|
||||
pyrcc4 icons.qrc -o gui/qt/icons_rc.py
|
||||
python setup.py sdist --format=zip,gztar
|
||||
In oder to creating binaries, you must create the 'packages' directory::
|
||||
|
||||
On Mac OS X::
|
||||
./contrib/pake_packages
|
||||
|
||||
|
||||
Mac OS X
|
||||
--------
|
||||
|
||||
# On port based installs
|
||||
sudo python setup-release.py py2app
|
||||
|
@ -54,3 +101,15 @@ On Mac OS X::
|
|||
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
|
||||
|
|
Loading…
Reference in New Issue