v. 1.0.0.0

2017-12-08 09:40:03 +07:00
parent 1d588bf976
commit 3a6bb4b0ce
1539 changed files with 340734 additions and 0 deletions
--- a/doc/README.md
+++ b/doc/README.md
@@ -0,0 +1,79 @@
+Neodash Core 0.12.1
+=====================
+
+This is the official reference wallet for Neodash digital currency and comprises the backbone of the Neodash peer-to-peer network. You can [download Neodash Core](https://www.neodash.org/downloads/) or [build it yourself](#building) using the guides below.
+
+Running
+---------------------
+The following are some helpful notes on how to run Neodash on your native platform.
+
+### Unix
+
+You need the Qt4 run-time libraries to run Neodash-Qt. On Debian or Ubuntu:
+
+	sudo apt-get install libqtgui4
+
+Unpack the files into a directory and run:
+
+- bin/32/neodash-qt (GUI, 32-bit) or bin/32/neodashd (headless, 32-bit)
+- bin/64/neodash-qt (GUI, 64-bit) or bin/64/neodashd (headless, 64-bit)
+
+
+
+### Windows
+
+Unpack the files into a directory, and then run neodash-qt.exe.
+
+### OS X
+
+Drag Neodash-Core to your applications folder, and then run Neodash-Core.
+
+### Need Help?
+
+* See the [Neodash documentation](https://neodashpay.atlassian.net/wiki/display/DOC)
+for help and more information.
+* Ask for help on [#neodashpay](http://webchat.freenode.net?channels=neodashpay) on Freenode. If you don't have an IRC client use [webchat here](http://webchat.freenode.net?channels=neodashpay).
+* Ask for help on the [NeodashTalk](https://neodashtalk.org/) forums.
+
+Building
+---------------------
+The following are developer notes on how to build Neodash 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 Neodash 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 the [NeodashTalk](https://neodashtalk.org/) forums, in the Development & Technical Discussion board.
+* Discuss on [#neodashpay](http://webchat.freenode.net/?channels=neodashpay) on Freenode. If you don't have an IRC client use [webchat here](http://webchat.freenode.net/?channels=neodashpay).
+
+### 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.