Electrum - lightweight Bitcoin client
Licence: GNU GPL v3
-Author: thomasv@gitorious
+Author: thomasv@bitcointalk.org
Language: Python
+Homepage: http://electrum.org/
-Features:
-* Encrypted wallet: the file that contains your bitcoins is protected with a password. You are protected from thieves.
-* Deterministic key generation: If you lose your wallet, you can recover it from its seed. You are protected from your own mistakes.
-* No blockchain download: the client requests blockchain information from a server. No delays, always up-to-date.
-* Transactions are signed locally: Your private keys are not shared with the server. You do not have to trust the server with your money.
-* Privacy: The server does not know you, it does not store user accounts. You are not tied to a particular server.
-* No single point of failure: The server code is open source, anyone can run a server.
-* Firewall friendly: The client does not need to open a port, it simply polls the server for updates.
-* Open Source: Anyone can audit the code.
-* Python. Very compact code, easy to contribute.
+== INSTALL ==
+ sudo python setup.py install
-INSTALL
-If you use the source from git, you will need to install python-ecdsa and slowaes:
-* sudo easy_install ecdsa
-* sudo easy_install slowaes
-These packages are included in the tar.gz and zip archives.
+== RUN ==
+To start Electrum in GUI mode, type:
-In order to use the gtk gui, you need pygtk and tk.
-* apt-get install python-gtk2
-* apt-get install python-tk
+ electrum
+== HELP ==
-RUN
+Up-to-date information and documentation is on the wiki:
+https://en.bitcoin.it/wiki/Electrum
-To start the Qt gui, type:
- python electrum
-To use the Gtk gui, type:
- python electrum --gui gtk
-If arguments are passed to the command line, Electrum will run in text mode.
-Examples:
- python electrum balance
- python electrum help
+== HOW OFFICIAL PACKAGES ARE CREATED ==
+python mki18n.py
+pyrcc4 icons.qrc -o gui/qt/icons_rc.py
+python setup.py sdist --format=zip,gztar
+On Mac OS X:
-HELP
+ # On port based installs
+ sudo python setup-release.py py2app
-the most up-to-date information is on the wiki:
-https://en.bitcoin.it/wiki/Electrum
+ # 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
+== BROWSER CONFIGURATION ==
-see http://ecdsa.org/bitcoin_URIs.html
+See http://electrum.org/bitcoin_URIs.html