update homepage

[electrum-nvc.git] / README

diff --git a/README b/README
index a1567d2..97ee960 100644 (file)
--- a/README
+++ b/README
@@ -3,58 +3,42 @@ Electrum - lightweight Bitcoin client
 Licence: GNU GPL v3
 Author: thomasv@gitorious
 Language: Python
+Homepage: http://electrum.ecdsa.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
-
-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.
-
-
-In order to use the gtk gui, you need pygtk and tk.
-* apt-get install python-gtk2
-* apt-get install python-tk
-
-
-To install Electrum, type:
+== INSTALL ==
 
   sudo python setup.py install
 
 
-RUN
+== RUN ==
 
 To start Electrum in GUI mode, type:
 
   electrum
 
+== HELP ==
 
-If arguments are passed to the command line, Electrum will run in text mode:
+Up-to-date information and documentation is on the wiki:
+https://en.bitcoin.it/wiki/Electrum
 
-  electrum balance
-  electrum help
 
+== HOW OFFICIAL PACKAGES ARE CREATED ==
 
+python mki18n.py
+pyrcc4 icons.qrc -o lib/icons_rc.py
+python setup.py sdist --format=zip,gztar
 
-HELP
+On Mac OS X:
 
-the most up-to-date information is on the wiki:
-https://en.bitcoin.it/wiki/Electrum
+  # 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
 
 
-BROWSER CONFIGURATION 
+== BROWSER CONFIGURATION ==
 
 see http://ecdsa.org/bitcoin_URIs.html