neobytes/doc/README.md

Neobytes Core 0.12.1
=====================

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.network/downloads/) or [build it yourself](#building) using the guides below.

Running
---------------------
The following are some helpful notes on how to run Neobytes on your native platform.

### Unix

Unpack the files into a directory and run:

- `bin/neobytes-qt` (GUI) or
- `bin/neobytesd` (headless)

### Windows

Unpack the files into a directory, and then run neobytes-qt.exe.

### OS X

Drag Neobytes-Qt to your applications folder, and then run Neobytes-Qt.

### Need Help?

* See the [Neobytes documentation](https://github.com/neobytes-project/neobytes/wiki)
for help and more information.
* 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).

Building
---------------------
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)
- [Gitian Building Guide](gitian-building.md)

Development
---------------------
The Neobytes Core repo's [root README](/README.md) contains relevant information on the development process and automated testing.

- [Developer Notes](developer-notes.md)
- [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)
- [Translation Strings Policy](translation_strings_policy.md)
- [Unit Tests](unit-tests.md)
- [Unauthenticated REST Interface](REST-interface.md)
- [Shared Libraries](shared-libraries.md)
- [BIPS](bips.md)
- [Dnsseed Policy](dnsseed-policy.md)

### Resources
* 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
---------------------
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.