neobytes/doc/README.md

74 lines
3.0 KiB
Markdown
Raw Normal View History

2024-02-05 23:00:22 +01:00
NeoBytes Core 0.12.1
=====================
2013-05-20 06:30:00 +02:00
2024-02-05 23:00:22 +01:00
This is the official reference wallet for NeoBytes digital currency and comprises the backbone of the NeoBytes peer-to-peer network. You can [download NeoBytes Core](https://www.neobytes.org/downloads/) or [build it yourself](#building) using the guides below.
Running
---------------------
2024-02-05 23:00:22 +01:00
The following are some helpful notes on how to run NeoBytes on your native platform.
### Unix
2013-05-20 06:30:00 +02:00
Unpack the files into a directory and run:
- `bin/bitcoin-qt` (GUI) or
- `bin/bitcoind` (headless)
2013-05-20 06:30:00 +02:00
### Windows
2024-02-05 23:00:22 +01:00
Unpack the files into a directory, and then run neobytes-qt.exe.
### OS X
2024-02-05 23:00:22 +01:00
Drag NeoBytes-Qt to your applications folder, and then run NeoBytes-Qt.
### Need Help?
2024-02-05 23:00:22 +01:00
* See the [NeoBytes documentation](https://neobytes.atlassian.net/wiki/display/DOC)
for help and more information.
2024-02-05 23:00:22 +01:00
* Ask for help on [#neobytes](http://webchat.freenode.net?channels=neobytes) on Freenode. If you don't have an IRC client use [webchat here](http://webchat.freenode.net?channels=neobytes).
* Ask for help on the [NeoBytesTalk](https://neobytestalk.org/) forums.
Building
2013-05-20 06:30:00 +02:00
---------------------
2024-02-05 23:00:22 +01:00
The following are developer notes on how to build NeoBytes Core on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc.
- [OS X Build Notes](build-osx.md)
- [Unix Build Notes](build-unix.md)
- [Windows Build Notes](build-windows.md)
- [OpenBSD Build Notes](build-openbsd.md)
2015-05-16 18:00:50 +02:00
- [Gitian Building Guide](gitian-building.md)
Development
---------------------
2024-02-05 23:00:22 +01:00
The NeoBytes Core repo's [root README](/README.md) contains relevant information on the development process and automated testing.
- [Developer Notes](developer-notes.md)
2013-05-20 06:30:00 +02:00
- [Multiwallet Qt Development](multiwallet-qt.md)
- [Release Notes](release-notes.md)
- [Release Process](release-process.md)
- Source Code Documentation ***TODO***
- [Translation Process](translation_process.md)
2015-05-22 13:09:56 +02:00
- [Translation Strings Policy](translation_strings_policy.md)
2013-05-20 06:30:00 +02:00
- [Unit Tests](unit-tests.md)
2015-05-16 18:00:50 +02:00
- [Unauthenticated REST Interface](REST-interface.md)
- [Shared Libraries](shared-libraries.md)
2015-05-16 18:00:50 +02:00
- [BIPS](bips.md)
- [Dnsseed Policy](dnsseed-policy.md)
### Resources
2024-02-05 23:00:22 +01:00
* Discuss on the [NeoBytesTalk](https://neobytestalk.org/) forums, in the Development & Technical Discussion board.
* Discuss on [#neobytes](http://webchat.freenode.net/?channels=neobytes) on Freenode. If you don't have an IRC client use [webchat here](http://webchat.freenode.net/?channels=neobytes).
### Miscellaneous
- [Assets Attribution](assets-attribution.md)
- [Files](files.md)
- [Tor Support](tor.md)
- [Init Scripts (systemd/upstart/openrc)](init.md)
License
---------------------
2014-12-13 05:09:33 +01:00
Distributed under the [MIT software license](http://www.opensource.org/licenses/mit-license.php).
This product includes software developed by the OpenSSL Project for use in the [OpenSSL Toolkit](https://www.openssl.org/). This product includes
cryptographic software written by Eric Young ([eay@cryptsoft.com](mailto:eay@cryptsoft.com)), and UPnP software written by Thomas Bernard.