Electrum - lightweight Bitcoin client
Licence: GNU GPL v3
-Author: thomasv@gitorious
+Author: Thomas Voegtlin
Language: Python
-Homepage: http://electrum-desktop.com/
+Homepage: https://electrum.org/
-== INSTALL ==
-
- sudo python setup.py install
+1. GETTING STARTED
+------------------
+To run Electrum from this directory, just do:
-== RUN ==
+ ./electrum
-To start Electrum in GUI mode, type:
+If you install Electrum on your system, you can run it from any
+directory:
+ sudo python setup.py install
electrum
-== HELP ==
-Up-to-date information and documentation is on the wiki:
-https://en.bitcoin.it/wiki/Electrum
+To start Electrum from your web browser, see
+http://electrum.org/bitcoin_URIs.html
-== HOW OFFICIAL PACKAGES ARE CREATED ==
+
+2. HOW OFFICIAL PACKAGES ARE CREATED
+------------------------------------
python mki18n.py
-pyrcc4 icons.qrc -o lib/icons_rc.py
+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 /usr/bin/python setup-release.py py2app --includes sip
- sudo hdiutil create -fs HFS+ -volname "Electrum" -srcfolder dist/Electrum.app dist/electrum-v0.61-macosx.dmg
+ # 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
-== BROWSER CONFIGURATION ==
-see http://ecdsa.org/bitcoin_URIs.html