neobytes/README.md

63 lines
3.2 KiB
Markdown
Raw Normal View History

2024-09-13 23:22:48 +02:00
NeoBytes core staging tree
===========================
2024-03-23 09:29:06 +01:00
https://www.neobytes.network
2024-09-13 23:22:48 +02:00
Further information about NeoBytes Core is available in [doc folder](/doc).
2024-03-23 09:29:06 +01:00
2024-09-13 23:32:15 +02:00
What is NeoBytes?
------------------
2024-03-23 09:29:06 +01:00
NeoBytes is an experimental new digital currency that enables anonymous, 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.
2024-02-05 23:00:22 +01:00
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.
2024-02-05 23:00:22 +01:00
For more information, as well as an immediately useable, binary version of the NeoBytes Core software, see <https://www.neobytes.network>
2014-12-12 12:09:19 +01:00
2024-02-05 23:00:22 +01:00
## NeoBytes FAQ
2024-02-05 23:00:22 +01:00
**Launch Date**: June 1, 2021
2024-02-05 23:00:22 +01:00
**Blockchain Type**: Decentralized
2014-12-12 12:09:19 +01:00
2024-02-05 23:00:22 +01:00
**Ticker Symbol**: NBY
2024-02-05 23:00:22 +01:00
**Genesis Block Hash**: "NeoBytes Genesis born on June 1, 2021"
2024-02-05 23:00:22 +01:00
**Mining Algorithm**: NeoScrypt
2010-09-23 20:06:50 +02:00
2011-09-27 04:22:19 +02:00
2024-09-13 23:32:15 +02:00
License
-------
2024-02-05 23:00:22 +01:00
NeoBytes Core is released under the terms of the MIT license. See [COPYING](COPYING) for more information or see <https://opensource.org/licenses/MIT>.
2010-12-19 16:39:36 +01:00
2024-09-13 23:32:15 +02:00
Development Process
-------------------
2024-02-05 23:00:22 +01:00
The `develop` branch is regularly built and tested, but is not guaranteed to be completely stable. Additionally, the develop branch represents ongoing development from which candidate releases will be cut.
The `master` branch represents the current stable version currently in production.
[Tags](https://github.com/neobytes-project/NeoBytes/tags) are created regularly to indicate new official, stable release versions of NeoBytes Core.
2024-02-05 23:00:22 +01:00
The contribution workflow is described in [CONTRIBUTING.md](CONTRIBUTING.md).
2024-09-13 23:32:15 +02:00
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
2011-09-27 04:22:19 +02:00
2024-02-05 23:00:22 +01:00
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).
2024-02-05 23:00:22 +01:00
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`
2024-02-05 23:00:22 +01:00
The Travis CI system makes sure that every pull request is built for Windows, Linux, and macOS, and that unit/sanity tests are run automatically.
### Manual Quality Assurance (QA) Testing
2024-02-05 23:00:22 +01:00
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.