New port numbers

[electrum-nvc.git] / README

diff --git a/README b/README
index 6bfd3b8..c1b49a4 100644 (file)
--- a/README
+++ b/README
@@ -1,37 +1,45 @@
-Electrum - a lightweight Bitcoin client and its server
+Electrum - lightweight Novacoin client
 
 Licence: GNU GPL v3
-Author: thomasv@gitorious
+Author: Thomas Voegtlin
 Language: Python
+Homepage: https://electrum.org/
+
+
+1. GETTING STARTED
+------------------
+
+To run Electrum from this directory, just do:
+
+  ./electrum-nvc
+
+If you install Electrum on your system, you can run it from any
+directory:
+
+  sudo python setup.py install
+  electrum-nvc
+
+
+To start Electrum from your web browser, see
+http://electrum.org/bitcoin_URIs.html
+
+
+
+2. 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:
+
+  # 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-NVC" -srcfolder dist/Electrum-NVC.app dist/electrum-nvc-VERSION-macosx.dmg
+
 
-Main features:
-
-Client:
- * The client uses a deterministic wallet; if the wallet is lost, it can be recovered from its passphrase.
- * The client does not download the Bitcoin blockchain; it requests that information from the server
- * The client does not send its private keys to the server.
- * The client does not need to open a port, it simply polls the server for updates.
-
-Server:
- * The server uses a patched version of the Bitcoin daemon that can forward transactions, and bitcoin-abe
- * The server code is open source. Anyone can run a server, removing single points of failure concerns.
- * The server knows which set of Bitcoin addresses belong to the same wallet, which might raise concerns about anonymity. 
-However, it should be possible to write clients capable of using several servers.
-
-----------------------------------------------------------
-INSTALLATION
-
-Client:  
-1. install python-ecdsa and pycrypto:
-   * sudo easy_install ecdsa
-   * sudo easy_install pycrypto
-2. run the client:
-   python electrum
-
-Server:
-
-1. patch and recompile the bitcoin daemon - bitcoinrpc.diff
-2. install bitcoin-abe : https://github.com/jtobey/bitcoin-abe
-3. install bitcoinrpc : https://gitorious.org/python-bitcoin
-     patch it too, see bitcoinrpc_connection.py.diff
-4. launch the server:  python server.py