neobytes/README.md

Neobytes Core integration/staging tree
======================================

https://www.neobytes.network

Further information about Neobytes Core is available in [doc folder](/doc).

What is Neobytes?
-----------------

Neobytes is an experimental new digital currency that enables instant payments to
anyone, anywhere in the world. Neobytes uses peer-to-peer technology to
operate with no central authority: managing transactions and issuing money
are carried out collectively by the network. Neobytes Core is the name of the open
source software which enables the use of this currency.

Neobytes uses a hash algorithm NeoScrypt. Based on a total Proof of Work and
Masternode system, it is accesible to everyone, it ensures a fair and stable
return of investment for the Graphics Processing Units (GPUs) miners and the
Masternode holders.

For more information, as well as an immediately useable, binary version of
the Neobytes Core software, see [https://www.neobytes.network](https://www.neobytes.network).

## Neobytes FAQ

**Launch Date**: June 1, 2021

**Blockchain Type**: Decentralized

**Ticker Symbol**: NBY

**Genesis Block Hash**: "Neobytes Genesis born on June 1, 2021"

**Mining Algorithm**: NeoScrypt


License
-------

Neobytes Core is released under the terms of the MIT license.
See [COPYING](COPYING) for more information or see https://opensource.org/licenses/MIT.

Development Process
-------------------

The `master` branch is meant to be stable. Development is normally done in separate branches.
[Tags](https://github.com/neobytes-project/neobytes/tags) are created to indicate new official,
stable release versions of Neobytes Core.

The contribution workflow is described in [CONTRIBUTING.md](CONTRIBUTING.md).

Testing
-------

Testing and code review is the bottleneck for development; we get more pull
requests than we can review and test on short notice. Please be patient and help out by testing
other people's pull requests, and remember this is a security-critical project where any mistake might cost people
lots of money.

### Automated Testing

Developers are required to write [unit tests](src/test/README.md) for new code, and to submit new unit tests for any old code that is changed. Unit tests can be compiled and run (assuming they weren't disabled in configure) with: `make check`. Further details on running and extending unit tests can be found in [/src/test/README.md](/src/test/README.md).

There are also [regression and integration tests](/test), written in Python, that are run automatically on the build server.
These tests can be run (if the [test dependencies](/test) are installed) with: `test/functional/test_runner.py`

### Manual Quality Assurance (QA) Testing

Changes should be tested by somebody other than the developer who wrote the code.
This is especially important for large or high-risk changes. It is useful to add a test plan to the pull request description if testing the changes is not straightforward.