maxmustermann/dogecoin
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Cleaning up docs

Browse source
This commit is contained in:
siavashg 2013-12-24 02:26:19 +00:00
parent b3b725906c
commit 2b3d01bae0
4 changed files with 103 additions and 105 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
README
View file

@ -1 +0,0 @@
README.md

52
README.md
View file

@ -1,29 +1,59 @@
DogeCoin [DOGE] DogeCoin [DOGE]
![Dogecoin](http://static.tumblr.com/ppdj5y9/Ae9mxmxtp/300coin.png)
# What is Dogecoin? - Such coin
Dogecoin is like Bitcoin, but based on Litecoin, and also much more wow.
http://dogecoin.com/
# License - Much license
Dogecoin is released under the terms of the MIT license. See [COPYING](COPYING)
for more information or see http://opensource.org/licenses/MIT.
# Development and contributions - omg developers
Developers work in their own trees, then submit pull requests when they think
their feature or bug fix is ready.
# Very Much Frequently Asked Questions
## How much doge can exist?
Total of 100,000,000,000 much coins
## How get doge?
Scrypt Proof of Work Scrypt Proof of Work
RPC 22555
P2P 22556
1 Minute Block Targets, 4 Hour Diff Readjustments 1 Minute Block Targets, 4 Hour Diff Readjustments
Total of 100,000,000,000 coins.
Special reward system: Random block rewards Special reward system: Random block rewards
1-100,000: 0-1,000,000 DogeCoin Reward 1-100,000: 0-1,000,000 DogeCoin Reward
100,001 — 200,000: 0-500,000 DogeCoin Reward 100,001 — 200,000: 0-500,000 DogeCoin Reward
200,001 — 300,000: 0-250,000 DogeCoin Reward 200,001 — 300,000: 0-250,000 DogeCoin Reward
300,001 — 400,000: 0-125,000 DogeCoin Reward 300,001 — 400,000: 0-125,000 DogeCoin Reward
400,001 — 500,000: 0-62,500 DogeCoin Reward 400,001 — 500,000: 0-62,500 DogeCoin Reward
500,001 - 600,000: 0-31,250 DogeCoin Reward 500,001 - 600,000: 0-31,250 DogeCoin Reward
600,000+ — 10,000 Reward (flat) 600,000+ — 10,000 Reward (flat)
## Wow plz make dogecoind
sudo apt-get install build-essential \
libssl-dev \
libdb5.1++-dev \
libboost-all-dev \
libqrencode-dev \
libminiupnpc-dev
cd src/
make -f makefile.unix USE_UPNP=1 USE_IPV6=1 USE_QRCODE=1
## Such ports
RPC 22555
P2P 22556
![](http://dogesay.com/wow//////such/coin) ![](http://dogesay.com/wow//////such/coin)

149
doc/build-unix.txt
View file

@ -1,5 +1,6 @@
Copyright (c) 2009-2012 Bitcoin Developers Copyright (c) 2009-2012 Bitcoin Developers
Copyright (c) 2011-2012 Litecoin Developers Copyright (c) 2011-2012 Litecoin Developers
Copyright (c) 2013 Dogecoin Developers
Distributed under the MIT/X11 software license, see the accompanying Distributed under the MIT/X11 software license, see the accompanying
file COPYING or http://www.opensource.org/licenses/mit-license.php. file COPYING or http://www.opensource.org/licenses/mit-license.php.
This product includes software developed by the OpenSSL Project for use in This product includes software developed by the OpenSSL Project for use in
@ -15,21 +16,30 @@ To Build
-------- --------
cd src/ cd src/
make -f makefile.unix # Headless litecoin make -f makefile.unix # Headless dogecoind
See readme-qt.rst for instructions on building Litecoin-Qt, See readme-qt.rst for instructions on building Dogecoin-Qt,
the graphical user interface. the graphical user interface.
Dependencies Build Instructions Ubuntu (13.04 Raring)
------------ ----------------------------------------
Library Purpose Description sudo apt-get install build-essential \
------- ------- ----------- libssl-dev \
libssl SSL Support Secure communications libdb5.1++-dev \
libdb4.8 Berkeley DB Blockchain & wallet storage libboost-all-dev \
libboost Boost C++ Library libqrencode-dev \
miniupnpc UPnP Support Optional firewall-jumping support libminiupnpc-dev
libqrencode QRCode generation Optional QRCode generation
cd src/
make -f makefile.unix USE_UPNP=1 USE_IPV6=1 USE_QRCODE=1
Unless you're debugging, strip debug symbols
strip dogecoind
Options
-------
miniupnpc may be used for UPnP port mapping. It can be downloaded from miniupnpc may be used for UPnP port mapping. It can be downloaded from
http://miniupnp.tuxfamily.org/files/. UPnP support is compiled in and http://miniupnp.tuxfamily.org/files/. UPnP support is compiled in and
@ -47,110 +57,63 @@ your package manager. Set USE_QRCODE to control this:
IPv6 support may be enabled by setting IPv6 support may be enabled by setting
USE_IPV6=1 Enable IPv6 support USE_IPV6=1 Enable IPv6 support
Licenses of statically linked libraries: Dependencies
Berkeley DB New BSD license with additional requirement that linked ------------
software must be free open source
Boost MIT-like license
miniupnpc New (3-clause) BSD license
Versions used in this release: Library Version Purpose Description
GCC 4.3.3 ------- ------- ------- -----------
OpenSSL 0.9.8g libssl 1.0.1c SSL Support Secure communications
Berkeley DB 4.8.30.NC libdb 5.1.29 Berkeley DB Blockchain & wallet storage
Boost 1.37 libboost 1.49.0.1 Boost C++ Library
miniupnpc 1.6 miniupnpc 1.6.3 UPnP Support Optional firewall-jumping support
libqrencode 3.4.1 QRCode generation Optional QRCode generation
Dependency Build Instructions: Ubuntu & Debian gcc 4:4.7.3
----------------------------------------------
sudo apt-get install build-essential
sudo apt-get install libssl-dev
sudo apt-get install libdb4.8-dev
sudo apt-get install libdb4.8++-dev
Boost 1.40+: sudo apt-get install libboost-all-dev
or Boost 1.37: sudo apt-get install libboost1.37-dev
sudo apt-get install libqrencode-dev
If using Boost 1.37, append -mt to the boost libraries in the makefile.
Dependency Build Instructions: Gentoo
-------------------------------------
emerge -av1 --noreplace boost glib openssl sys-libs/db:4.8
Take the following steps to build (no UPnP support):
cd ${LITECOIN_DIR}/src
make -f makefile.unix USE_UPNP= USE_IPV6=1 BDB_INCLUDE_PATH='/usr/include/db4.8'
strip litecoind
Notes
-----
The release is built with GCC and then "strip litecoind" to strip the debug
symbols, which reduces the executable size by about 90%.
miniupnpc
---------
tar -xzvf miniupnpc-1.6.tar.gz
cd miniupnpc-1.6
make
sudo su
make install
Berkeley DB
-----------
You need Berkeley DB 4.8. If you have to build Berkeley DB yourself:
../dist/configure --enable-cxx
make
Boost
-----
If you need to build Boost yourself:
sudo su
./bootstrap.sh
./bjam install
See licenses.txt for license details
Security Security
-------- --------
To help make your litecoin installation more secure by making certain attacks impossible to To help make your dogecoin installation more secure by making certain attacks
exploit even if a vulnerability is found, you can take the following measures: impossible to exploit even if a vulnerability is found, you can take the
following measures:
* Position Independent Executable * Position Independent Executable
Build position independent code to take advantage of Address Space Layout Randomization Build position independent code to take advantage of Address Space Layout
offered by some kernels. An attacker who is able to cause execution of code at an arbitrary Randomization offered by some kernels. An attacker who is able to cause
memory location is thwarted if he doesn't know where anything useful is located. execution of code at an arbitrary memory location is thwarted if he doesn't
The stack and heap are randomly located by default but this allows the code section to be know where anything useful is located. The stack and heap are randomly
randomly located as well. located by default but this allows the code section to be randomly located
as well.
On an Amd64 processor where a library was not compiled with -fPIC, this will cause an error On an Amd64 processor where a library was not compiled with -fPIC, this
such as: "relocation R_X86_64_32 against `......' can not be used when making a shared object;" will cause an error such as: "relocation R_X86_64_32 against `......' can
not be used when making a shared object;"
To build with PIE, use: To build with PIE, use:
make -f makefile.unix ... -e PIE=1 make -f makefile.unix ... -e PIE=1
To test that you have built PIE executable, install scanelf, part of paxutils, and use: To test that you have built PIE executable, install scanelf, part of
scanelf -e ./litecoin paxutils, and use:
scanelf -e ./dogecoind
The output should contain: The output should contain:
TYPE TYPE
ET_DYN ET_DYN
* Non-executable Stack * Non-executable Stack
If the stack is executable then trivial stack based buffer overflow exploits are possible if If the stack is executable then trivial stack based buffer overflow
vulnerable buffers are found. By default, litecoin should be built with a non-executable stack exploits are possible if vulnerable buffers are found. By default,
but if one of the libraries it uses asks for an executable stack or someone makes a mistake dogecoind should be built with a non-executable stack but if one of the
and uses a compiler extension which requires an executable stack, it will silently build an libraries it uses asks for an executable stack or someone makes a mistake
executable without the non-executable stack protection. and uses a compiler extension which requires an executable stack, it will
silently build an executable without the non-executable stack protection.
To verify that the stack is non-executable after compiling use: To verify that the stack is non-executable after compiling use:
scanelf -e ./litecoin scanelf -e ./dogecoind
the output should contain: the output should contain:
STK/REL/PTL STK/REL/PTL
RW- R-- RW- RW- R-- RW-
The STK RW- means that the stack is readable and writeable but not executable. The STK RW- means that the stack is readable and writeable but not
executable.

6
doc/licenses.txt Normal file
View file

@ -0,0 +1,6 @@
Licenses of statically linked libraries:
----------------------------------------
Berkeley DB New BSD license with additional requirement that linked
software must be free open source
Boost MIT-like license
miniupnpc New (3-clause) BSD license