README: move to reST format

This commit is contained in:
Roman Zeyde 2015-06-27 10:58:45 +03:00
parent b89c0144a2
commit a34169d81f
2 changed files with 61 additions and 53 deletions

53
README
View File

@ -1,53 +0,0 @@
Electrum - lightweight Bitcoin client
Licence: GNU GPL v3
Author: Thomas Voegtlin
Language: Python
Homepage: https://electrum.org/
1. GETTING STARTED
------------------
To run Electrum from this directory, just do:
./electrum
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
To start Electrum from your web browser, see
http://electrum.org/bitcoin_URIs.html
2. HOW OFFICIAL PACKAGES ARE CREATED
------------------------------------
pyrcc4 icons.qrc -o gui/qt/icons_rc.py
python setup.py sdist --format=zip,gztar
On 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

61
README.rst Normal file
View File

@ -0,0 +1,61 @@
Electrum - lightweight Bitcoin client
=====================================
::
Licence: GNU GPL v3
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
1. GETTING STARTED
------------------
To run Electrum from this directory, just do::
./electrum
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
To start Electrum from your web browser, see
http://electrum.org/bitcoin_URIs.html
2. HOW OFFICIAL PACKAGES ARE CREATED
------------------------------------
On Linux/Windows::
pyrcc4 icons.qrc -o gui/qt/icons_rc.py
python setup.py sdist --format=zip,gztar
On 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