shadowproject/shadow

View on GitHub
README.md

Summary

Maintainability
Test Coverage
![ShadowCash Logo](https://i.imgur.com/ovemJA3.png)

[![Slack](https://slack.shadowproject.io/badge.svg)](https://slack.shadowproject.io/)
[![Gitter](https://badges.gitter.im/shadowproject/shadow.svg)](https://gitter.im/shadowproject/shadow?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=body_badge) [![Build Status](https://travis-ci.org/shadowproject/shadow.svg?branch=master)](https://travis-ci.org/shadowproject/shadow) [![Code Climate](https://codeclimate.com/github/shadowproject/shadow/badges/gpa.svg)](https://codeclimate.com/github/shadowproject/shadow) [![Test Coverage](https://codeclimate.com/github/shadowproject/shadow/badges/coverage.svg)](https://codeclimate.com/github/shadowproject/shadow/coverage) 

Introduction
===========================

The Shadow Project  is a decentralized peer-to-peer platform, created under an open source license, featuring a built-in cryptocurrency, end-to-end encrypted messaging and decentralized marketplace. The decentralized network aims to provide anonymity and privacy for everyone through a simple user-friendly interface by taking care of all the advanced cryptography in the background. 

* [Website](https://shadowproject.io/)
* [Blog](https://blog.shadowproject.io/)
* [Documentation](https://doc.shadowproject.io/)
* [Forum](https://talk.shadowproject.io/)

"They who can give up essential liberty to obtain a little temporary safety deserve neither liberty nor safety." 

Releases
===========================
[Click on this link to go to the latest release - 1.5.0.3](https://github.com/shadowproject/shadow/releases/latest)

Supported Operating Systems:
* Linux (64 bit)
* ~~Linux (32 bit)~~
* Windows (32 bit)
* Windows (64 bit)
* OSX 


Linux releases will not work out of the box on the Raspberry Pi, you'll have to compile from source.

Development process
===========================

Developers work in their own trees, then submit pull requests when
they think their feature or bug fix is ready.

The patch will be accepted if there is broad consensus that it is a
good thing.  Developers should expect to rework and resubmit patches
if they don't match the project's coding conventions (see coding.txt)
or are controversial.

The master branch is regularly built and tested, but is not guaranteed
to be completely stable. Tags are regularly created to indicate new
stable release versions of ShadowCash.

Feature branches are created when there are major new features being
worked on by several people.

From time to time a pull request will become outdated. If this occurs, and
the pull is no longer automatically mergeable; a comment on the pull will
be used to issue a warning of closure. The pull will be closed 15 days
after the warning if action is not taken by the author. Pull requests closed
in this manner will have their corresponding issue labeled 'stagnant'.

Issues with no commits will be given a similar warning, and closed after
15 days from their last activity. Issues closed in this manner will be 
labeled 'stale'.

Building Shadow
===========================

See [doc/readme-qt.rst](https://github.com/shadowproject/shadow/blob/master/doc/readme-qt.rst) for instructions on building **ShadowCoin QT** | *the intended-for-end-users, nice-graphical-interface, reference implementation of ShadowCash.*

See [doc/build-msw.txt](https://github.com/shadowproject/shadow/blob/master/doc/build-msw.txt) for instructions on building **shadowcoind (Windows)** | *the intended-for-services, no-graphical-interface, reference implementation of ShadowCash.*

See [doc/build-osx.txt](https://github.com/shadowproject/shadow/blob/master/doc/build-osx.txt) for instructions on building **shadowcoind (Mac)**

See [doc/build-unix.txt](https://github.com/shadowproject/shadow/blob/master/doc/build-unix.txt) for instructions on building **shadowcoind (UNIX)**


> For guides and technical documentation please refer to [doc.shadowproject.io (en)](https://shadowproject.io/en/documentation)