Skip to content

Commit

Permalink
Added README
Browse files Browse the repository at this point in the history
  • Loading branch information
CodeShark committed Dec 29, 2013
1 parent 5198981 commit 2ab7b5c
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 0 deletions.
1 change: 1 addition & 0 deletions README
58 changes: 58 additions & 0 deletions README.md
@@ -0,0 +1,58 @@
V A U L T (TM)
===============================================================================
Copyright (c) 2013 Ciphrex LLC, All Rights Reserved.


Vault is an interactive desktop application for transacting on the bitcoin network
which supports m-of-n signature policies and multiuser/multidevice account management.

It is built atop two custom libraries, CoinClasses and CoinQ, which provide
all core functionality for managing bitcoin data structures and connecting to peers.

In addition, Vault depends on the following:

- Qt5 application and UI framework http://qt-project.org/
* Qt5Core
* Qt5Gui
* Qt5Widgets
* Qt5Network

- Boost C++ Libraries (1.49 or greater) http://www.boost.org/
* boost_system
* boost_filesystem
* boost_regex
* boost_thread
* boost_log

- OpenSSL (including EC module) http://www.openssl.org/
* crypto

- ODB: C++ Object-Relational Mapping http://www.codesynthesis.com/products/odb/download.xhtml
* ODB Compiler (odb)
* Common Runtime Library (libodb)
* SQLite Database Runtime Library (libodb-sqlite)

Vault has been built in Linux using gcc 4.6.3 and greater for both 64-bit Linux
and 64-bit Windows (cross-build, mingw64).

CoinClasses and CoinQ have also been built using clang 4.1 in OS X (10.7 and greater).


To build for linux:
$ ./build-all.sh linux

To build for windows
$ ./build-all.sh mingw64

===============================================================================

DISCLAIMER:

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

0 comments on commit 2ab7b5c

Please sign in to comment.