Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replacing readme with clear deprecation note #333

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Replacing readme with clear deprecation note #333

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 1 addition & 86 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,86 +1 @@
##Armory

**Created by Alan Reiner on 13 July, 2011**

[Armory](https://github.com/etotheipi/BitcoinArmory) is a full-featured Bitcoin client, offering a dozen innovative features not found in any other client software! Manage multiple wallets (deterministic and watching-only), print paper backups that work forever, import or sweep private keys, and keep your savings in a computer that never touches the internet, while still being able to manage incoming payments, and create outgoing payments with the help of a USB key.

Multi-signature transactions are accommodated under-the-hood about 80%, and will be completed and integrated into the UI soon.

**Armory has no independent networking components built in.** Instead, it relies on on the Satoshi client to securely connect to peers, validate blockchain data, and broadcast transactions for us. Although it was initially planned to cut the umbilical cord to the Satoshi client and implement independent networking, it has turned out to be an inconvenience worth having. Reimplementing all the networking code would be fraught with bugs, security holes, and possible blockchain forking. The reliance on Bitcoin-Qt right now is actually making Armory more secure!

##Donations

Please take a moment to donate! 1ArmoryXcfq7TnCSuZa9fQjRYwJ4bkRKfv

![bitcoin:1ArmoryXcfq7TnCSuZa9fQjRYwJ4bkRKfv][Donation Image]

##Building Armory From Source

See instructions [here][Armory Build Instructions]


##Dependencies

* GNU Compiler Collection
Linux: Install package `g++`

* Crypto++
Linux: Install package `libcrypto++-dev`
Windows: [Download][Windows Crypto Download]

* SWIG
Linux: Install package `swig`
Windows: [Download][Windows SWIG Download]
MSVS: Copy swigwin-2.x directory next to cryptopp as `swigwin`

* Python 2.6/2.7
Linux: Install package `python-dev`
Windows: [Download][Windows Python Download]

* Python Twisted -- asynchronous networking
Linux: Install package `python-twisted`
Windows: [Download][Windows Twisted Download]

* PyQt 4 (for Python 2.X)
Linux: Install packages `libqtcore4`, `libqt4-dev`, `python-qt4`, and `pyqt4-dev-tools`
Windows: [Download][Windows QT Download]

* qt4reactor.py -- combined eventloop for PyQt and Twisted
All OS: [Download][QT4 Reactor Download]

* pywin32
Windows Only: qt4reactor relies on pywin32 (for win32event module). [Download][Windows PyWin Download]

* py2exe
(OPTIONAL - if you want to make a standalone executable in Windows)
Windows: [Download][Windows Py2Exe Download]

##Sample Code

Armory contains over 25,000 lines of code, between the C++ and python libraries. This can be very confusing for someone unfamiliar with the code (you). Below I have attempted to illustrate the CONOPS (concept of operations) that the library was designed for, so you know how to use it in your own development activities. There is a TON of sample code in the following:

* C++ - [BlockUtilsTest.cpp](cppForSwig/BlockUtilsTest.cpp)
* Python - [Unit Tests](pytest/), [sample_armory_code.py](extras/sample_armory_code.py)


##License

Distributed under the GNU Affero General Public License (AGPL v3)
See [LICENSE file](LICENSE) or [here][License]

##Copyright

Copyright (C) 2011-2015, Armory Technologies, Inc.


[Armory Build Instructions]: https://bitcoinarmory.com/building-from-source
[Windows Crypto Download]: http://www.cryptopp.com/#download
[Windows SWIG Download]: http://www.swig.org/download.html
[Windows Python Download]: http://www.python.org/getit/
[Windows Twisted Download]: http://twistedmatrix.com/trac/wiki/Downloads
[Windows QT Download]: http://www.riverbankcomputing.co.uk/software/pyqt/download
[QT4 Reactor Download]: https://launchpad.net/qt4reactor
[Windows PyWin Download]: http://sourceforge.net/projects/pywin32/files/pywin32/
[Windows Py2Exe Download]: http://www.py2exe.org/
[License]: http://www.gnu.org/licenses/agpl.html
[Donation Image]: https://chart.googleapis.com/chart?chs=250x250&cht=qr&chl=bitcoin:1ArmoryXcfq7TnCSuZa9fQjRYwJ4bkRKfv?&label=Armory+Donation
This repository is deprecated as it has moved to https://github.com/goatpig/BitcoinArmory