diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..79eb749 --- /dev/null +++ b/COPYING @@ -0,0 +1,20 @@ +Copyright (c) 2013-2015 The Anoncoin Developers +Copyright (c) 2017 GOSTCoin Developers + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..2996ed3 --- /dev/null +++ b/README.md @@ -0,0 +1,67 @@ +GOSTCoin Core +============= + +GOSTCoin (GST) is a digital currency based on [blockchain](https://en.wikipedia.org/wiki/Blockchain) technology. +It allows instant payments worldwide with focus on privacy and security of its users. + +Why GOSTCoin? +------------- + +GOSTCoin uses Soviet and Russian government standard cryptography: +GOST R 34.10-2012 for signature and GOST R 34.11-2012 for hash. +[https://github.com/GOSTSec/gostcoin/wiki/Cryptography](More info about crypto). + +GOSTCoin is using [Invisible Internet](https://github.com/PurpleI2P/i2pd) (I2P) as a secure network layer. + +GOSTCoin needs I2P router +------------------------- + +Install and run [i2pd](https://github.com/PurpleI2P/i2pd). + +Enable SAM API in i2pd. Edit in `i2pd.conf`: + + [sam] + enabled = true + +and restart i2pd. Local TCP port 7656 should be available. + +Building GOSTCoin +----------------- + +**Install development libraries:** + + apt-get install build-essential libtool libboost-all-dev git libdb++-dev libssl-dev zlib1g-dev + +**Clone repository:** + + git clone https://github.com/GOSTSec/gostcoin.git ~/gostcoin + +**Build dependencies:** + + cd ~/gostcoin/i2psam/ + make -f makefile.unix + +**Build gostcoind:** + + cd ~/gostcoin/src + make -f makefile.unix + +**Optional: Build QT GUI** + + # install requirements + apt-get install libqt5gui5 libqt5core5 libqt5dbus5 qttools5-dev qttools5-dev-tools libprotobuf-dev protobuf-compiler libqrencode-dev + # build GUI + cd ~/gostcoin + qmake && make + +Mining tools +------------ + +Dedicated mining tools are available: [https://github.com/GOSTSec/cpuminer-x11-gost](cpuminer for CPU) and [https://github.com/GOSTSec/ccminer](ccminer for GPU) + +License +------- + +GOSTCoin Core is released under the terms of the MIT license. See [COPYING](COPYING) for more +information or see http://opensource.org/licenses/MIT. +