X-Git-Url: https://git.novaco.in/?a=blobdiff_plain;f=README;h=6e15442590a33945a9ff28e87b4ad61bb8bb5081;hb=4c2135f58d053f5cb25138eb6d753f05ccee7187;hp=895237b1d75c83029ac0ae458c86d37ac5a91629;hpb=d18025896b62211664f53b5769313aa937c4d8b4;p=electrum-nvc.git diff --git a/README b/README index 895237b..6e15442 100644 --- a/README +++ b/README @@ -1,37 +1,44 @@ -Electrum - a lightweight Bitcoin client and its server +Electrum - lightweight Bitcoin client Licence: GNU GPL v3 -Author: thomasv1@gmx.de +Author: thomasv@gitorious Language: Python +Homepage: http://ecdsa.org/electrum -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 keyes 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 -3. install bitcoinrpc, patch it too -3. launch the server: - python server.py + +== INSTALL == + + sudo python setup.py install + + +== RUN == + +To start Electrum in GUI mode, type: + + electrum + +== HELP == + +Up-to-date information and documentation is on the wiki: +https://en.bitcoin.it/wiki/Electrum + + +== HOW OFFICIAL PACKAGES ARE CREATED == + +python mki18n.py +pyrcc4 icons.qrc -o lib/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 + + +== BROWSER CONFIGURATION == + +see http://ecdsa.org/bitcoin_URIs.html