From eddb971ffd1129edf851ab5d1fae84c6c492405e Mon Sep 17 00:00:00 2001 From: Ross Nicoll Date: Mon, 24 Mar 2014 18:54:46 +0000 Subject: [PATCH] Completed replacement of Bitcoin with Dogecoin in core documentation. --- doc/README.md | 10 +++--- doc/README_windows.txt | 4 +-- doc/assets-attribution.md | 6 ++-- doc/build-msw.md | 2 +- doc/build-unix.md | 12 +++---- doc/multiwallet-qt.md | 6 ++-- doc/release-process.md | 74 ++++++++++++++++++-------------------- doc/tor.md | 18 +++++----- doc/translation_process.md | 2 +- doc/unit-tests.md | 8 ++--- 10 files changed, 69 insertions(+), 73 deletions(-) diff --git a/doc/README.md b/doc/README.md index 1bd0097f5..150770177 100644 --- a/doc/README.md +++ b/doc/README.md @@ -6,7 +6,7 @@ Copyright (c) 2009-2014 Bitcoin Developers Setup --------------------- -[Dogecoin Core](http://bitcoin.org/en/download) is the original Dogecoin client and it builds the backbone of the network. However, it downloads and stores the entire history of Dogecoin transactions (which is currently several GBs); depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few hours to a day or more. Thankfully you only have to do this once. If you would like the process to go faster you can [download the blockchain directly](https://bitcointalk.org/index.php?topic=145386.0). +[Dogecoin Core](http://dogecoin.com/en/download) is the original Dogecoin client and it builds the backbone of the network. However, it downloads and stores the entire history of Dogecoin transactions (which is currently several GBs); depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few hours to a day or more. Thankfully you only have to do this once. Running --------------------- @@ -35,10 +35,10 @@ Drag Dogecoin-Qt to your applications folder, and then run Dogecoin-Qt. ### Need Help? -* See the documentation at the [Dogecoin Wiki](https://en.bitcoin.it/wiki/Main_Page) +* See the documentation at the [Dogecoin Wiki](http://dogeco.in/) for help and more information. -* Ask for help on [#bitcoin](http://webchat.freenode.net?channels=bitcoin) on Freenode. If you don't have an IRC client use [webchat here](http://webchat.freenode.net?channels=bitcoin). -* Ask for help on the [BitcoinTalk](https://bitcointalk.org/) forums, in the [Technical Support board](https://bitcointalk.org/index.php?board=4.0). +* Ask for help on [#dogecoin](http://webchat.freenode.net?channels=dogecoin) on Freenode. If you don't have an IRC client use [webchat here](http://webchat.freenode.net?channels=dogecoin). +* Ask for help on the [/r/dogeducation subreddit](http://reddit.com/r/dogeducation). Building --------------------- @@ -50,7 +50,7 @@ The following are developer notes on how to build Dogecoin on your native platfo Development --------------------- -The Dogecoin repo's [root README](https://github.com/bitcoin/bitcoin/blob/master/README.md) contains relevant information on the development process and automated testing. +The Dogecoin repo's [root README](https://github.com/dogecoin/dogecoin/blob/master/README.md) contains relevant information on the development process and automated testing. - [Coding Guidelines](coding.md) - [Multiwallet Qt Development](multiwallet-qt.md) diff --git a/doc/README_windows.txt b/doc/README_windows.txt index 4be7ee170..5775a38ea 100644 --- a/doc/README_windows.txt +++ b/doc/README_windows.txt @@ -19,7 +19,7 @@ with each other, with the help of a P2P network to check for double-spending. Setup ----- -Unpack the files into a directory and run bitcoin-qt.exe. +Unpack the files into a directory and run dogecoin-qt.exe. Dogecoin Core is the original Dogecoin client and it builds the backbone of the network. However, it downloads and stores the entire history of Dogecoin transactions; @@ -27,5 +27,5 @@ depending on the speed of your computer and network connection, the synchronizat process can take anywhere from a few hours to a day or more. See the Dogecoin wiki at: - https://en.bitcoin.it/wiki/Main_Page + http://dogeco.in/ for more help and information. diff --git a/doc/assets-attribution.md b/doc/assets-attribution.md index d42be8fb2..6f4bec44a 100644 --- a/doc/assets-attribution.md +++ b/doc/assets-attribution.md @@ -97,8 +97,8 @@ Jonas Schnelli * License: MIT ### Assets Used - src/qt/res/icons/bitcoin.icns, src/qt/res/src/bitcoin.svg, - src/qt/res/src/bitcoin.ico, src/qt/res/src/bitcoin.png, - src/qt/res/src/bitcoin_testnet.png, docs/bitcoin_logo_doxygen.png, + src/qt/res/icons/dogecoin.icns, src/qt/res/src/dogecoin.svg, + src/qt/res/src/dogecoin.ico, src/qt/res/src/dogecoin.png, + src/qt/res/src/dogecoin_testnet.png, docs/dogecoin_logo_doxygen.png, src/qt/res/icons/toolbar.png, src/qt/res/icons/toolbar_testnet.png, src/qt/res/images/splash.png, src/qt/res/images/splash_testnet.png diff --git a/doc/build-msw.md b/doc/build-msw.md index f18977c58..2f60fd8cb 100644 --- a/doc/build-msw.md +++ b/doc/build-msw.md @@ -80,4 +80,4 @@ MSYS shell: sh autogen.sh sh configure mingw32-make - strip bitcoind.exe + strip dogecoind.exe diff --git a/doc/build-unix.md b/doc/build-unix.md index b039ddb2b..0060587c7 100644 --- a/doc/build-unix.md +++ b/doc/build-unix.md @@ -9,7 +9,7 @@ To Build ./configure make -This will build bitcoin-qt as well if the dependencies are met. +This will build dogecoin-qt as well if the dependencies are met. Dependencies --------------------- @@ -116,14 +116,14 @@ For Qt 5 you need the following: libqrencode (optional) can be installed with: - apt-get install libqrencode-dev + sudo apt-get install libqrencode-dev -Once these are installed, they will be found by configure and a bitcoin-qt executable will be +Once these are installed, they will be found by configure and a dogecoin-qt executable will be built by default. Notes ----- -The release is built with GCC and then "strip bitcoind" to strip the debug +The release is built with GCC and then "strip dogecoind" to strip the debug symbols, which reduces the executable size by about 90%. @@ -181,7 +181,7 @@ Hardening enables the following features: To test that you have built PIE executable, install scanelf, part of paxutils, and use: - scanelf -e ./bitcoin + scanelf -e ./dogecoin The output should contain: TYPE @@ -195,7 +195,7 @@ Hardening enables the following features: executable without the non-executable stack protection. To verify that the stack is non-executable after compiling use: - `scanelf -e ./bitcoin` + `scanelf -e ./dogecoin` the output should contain: STK/REL/PTL diff --git a/doc/multiwallet-qt.md b/doc/multiwallet-qt.md index 3caab8180..e15cd66f9 100644 --- a/doc/multiwallet-qt.md +++ b/doc/multiwallet-qt.md @@ -1,7 +1,7 @@ Multiwallet Qt Development and Integration Strategy =================================================== -In order to support loading of multiple wallets in bitcoin-qt, a few changes in the UI architecture will be needed. +In order to support loading of multiple wallets in dogecoin-qt, a few changes in the UI architecture will be needed. Fortunately, only four of the files in the existing project are affected by this change. Two new classes have been implemented in two new .h/.cpp file pairs, with much of the functionality that was previously @@ -12,7 +12,7 @@ some major retrofitting. Only requiring some minor changes is bitcoin.cpp. -Finally, two new headers and source files will have to be added to bitcoin-qt.pro. +Finally, two new headers and source files will have to be added to dogecoin-qt.pro. Changes to class BitcoinGUI --------------------------- @@ -32,7 +32,7 @@ merges while reducing the risk of breaking top-level stuff. Changes to bitcoin.cpp ---------------------- -bitcoin.cpp is the entry point into bitcoin-qt, and as such, will require some minor modifications to provide hooks for +bitcoin.cpp is the entry point into dogecoin-qt, and as such, will require some minor modifications to provide hooks for multiple wallet support. Most importantly will be the way it instantiates WalletModels and passes them to the singleton BitcoinGUI instance called window. Formerly, BitcoinGUI kept a pointer to a single instance of a WalletModel. The initial change required is very simple: rather than calling `window.setWalletModel(&walletModel);` we perform the diff --git a/doc/release-process.md b/doc/release-process.md index 289f9dfde..b4ab2f9ac 100644 --- a/doc/release-process.md +++ b/doc/release-process.md @@ -27,11 +27,11 @@ Release Process ##perform gitian builds - From a directory containing the bitcoin source, gitian-builder and gitian.sigs + From a directory containing the dogecoin source, gitian-builder and gitian.sigs export SIGNER=(your gitian key, ie bluematt, sipa, etc) export VERSION=(new version, e.g. 0.8.0) - pushd ./bitcoin + pushd ./dogecoin git checkout v${VERSION} popd pushd ./gitian-builder @@ -51,29 +51,29 @@ Release Process wget 'https://download.qt-project.org/official_releases/qt/5.2/5.2.0/single/qt-everywhere-opensource-src-5.2.0.tar.gz' wget 'https://protobuf.googlecode.com/files/protobuf-2.5.0.tar.bz2' cd .. - ./bin/gbuild ../bitcoin/contrib/gitian-descriptors/boost-linux.yml + ./bin/gbuild ../dogecoin/contrib/gitian-descriptors/boost-linux.yml mv build/out/boost-*.zip inputs/ - ./bin/gbuild ../bitcoin/contrib/gitian-descriptors/deps-linux.yml - mv build/out/bitcoin-deps-*.zip inputs/ - ./bin/gbuild ../bitcoin/contrib/gitian-descriptors/boost-win.yml + ./bin/gbuild ../dogecoin/contrib/gitian-descriptors/deps-linux.yml + mv build/out/dogecoin-deps-*.zip inputs/ + ./bin/gbuild ../dogecoin/contrib/gitian-descriptors/boost-win.yml mv build/out/boost-*.zip inputs/ - ./bin/gbuild ../bitcoin/contrib/gitian-descriptors/deps-win.yml - mv build/out/bitcoin-deps-*.zip inputs/ - ./bin/gbuild ../bitcoin/contrib/gitian-descriptors/qt-win.yml + ./bin/gbuild ../dogecoin/contrib/gitian-descriptors/deps-win.yml + mv build/out/dogecoin-deps-*.zip inputs/ + ./bin/gbuild ../dogecoin/contrib/gitian-descriptors/qt-win.yml mv build/out/qt-*.zip inputs/ - ./bin/gbuild ../bitcoin/contrib/gitian-descriptors/protobuf-win.yml + ./bin/gbuild ../dogecoin/contrib/gitian-descriptors/protobuf-win.yml mv build/out/protobuf-*.zip inputs/ - Build bitcoind and bitcoin-qt on Linux32, Linux64, and Win32: + Build dogecoind and dogecoin-qt on Linux32, Linux64, and Win32: - ./bin/gbuild --commit bitcoin=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian-linux.yml - ./bin/gsign --signer $SIGNER --release ${VERSION} --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-linux.yml + ./bin/gbuild --commit bitcoin=v${VERSION} ../dogecoin/contrib/gitian-descriptors/gitian-linux.yml + ./bin/gsign --signer $SIGNER --release ${VERSION} --destination ../gitian.sigs/ ../dogecoin/contrib/gitian-descriptors/gitian-linux.yml pushd build/out zip -r dogecoin-${VERSION}-linux-gitian.zip * mv dogecoin-${VERSION}-linux-gitian.zip ../../../ popd - ./bin/gbuild --commit bitcoin=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian-win.yml - ./bin/gsign --signer $SIGNER --release ${VERSION}-win --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-win.yml + ./bin/gbuild --commit bitcoin=v${VERSION} ../dogecoin/contrib/gitian-descriptors/gitian-win.yml + ./bin/gsign --signer $SIGNER --release ${VERSION}-win --destination ../gitian.sigs/ ../dogecoin/contrib/gitian-descriptors/gitian-win.yml pushd build/out zip -r dogecoin-${VERSION}-win-gitian.zip * mv dogecoin-${VERSION}-win-gitian.zip ../../../ @@ -97,7 +97,7 @@ repackage gitian builds for release as stand-alone zip/tar/installer exe **Windows .zip and setup.exe:** unzip dogecoin-${VERSION}-win-gitian.zip -d dogecoin-${VERSION}-win - mv dogecoin-${VERSION}-win/bitcoin-*-setup.exe . + mv dogecoin-${VERSION}-win/dogecoin-*-setup.exe . zip -r dogecoin-${VERSION}-win.zip dogecoin-${VERSION}-win rm -rf dogecoin-${VERSION}-win @@ -111,7 +111,7 @@ repackage gitian builds for release as stand-alone zip/tar/installer exe make export QTDIR=/opt/local/share/qt4 # needed to find translations/qt_*.qm files T=$(contrib/qt_translations.py $QTDIR/translations src/qt/locale) - export CODESIGNARGS='--keychain ...path_to_keychain --sign "Developer ID Application: BITCOIN FOUNDATION, INC., THE"' + export CODESIGNARGS='--keychain ...path_to_keychain --sign "Developer ID Application: DOGECOIN FOUNDATION, INC., THE"' python2.7 contrib/macdeploy/macdeployqtplus Dogecoin-Qt.app -sign -add-qt-tr $T -dmg -fancy contrib/macdeploy/fancy.plist Build output expected: Dogecoin-Qt.dmg @@ -125,11 +125,9 @@ repackage gitian builds for release as stand-alone zip/tar/installer exe * create SHA256SUMS for builds, and PGP-sign it -* update bitcoin.org version +* update dogecoin.com version make sure all OS download links go to the right versions -* update download sizes on bitcoin.org/_templates/download.html - * update forum version * update wiki download links @@ -152,41 +150,39 @@ Commit your signature to gitian.sigs: From a directory containing bitcoin source, gitian.sigs and gitian zips export VERSION=(new version, e.g. 0.8.0) - mkdir dogecoin-${VERSION}-linux-gitian - pushd dogecoin-${VERSION}-linux-gitian + mkdir bitcoin-${VERSION}-linux-gitian + pushd bitcoin-${VERSION}-linux-gitian unzip ../dogecoin-${VERSION}-linux-gitian.zip mkdir gitian - cp ../bitcoin/contrib/gitian-downloader/*.pgp ./gitian/ + cp ../dogecoin/contrib/gitian-downloader/*.pgp ./gitian/ for signer in $(ls ../gitian.sigs/${VERSION}/); do - cp ../gitian.sigs/${VERSION}/${signer}/bitcoin-build.assert ./gitian/${signer}-build.assert - cp ../gitian.sigs/${VERSION}/${signer}/bitcoin-build.assert.sig ./gitian/${signer}-build.assert.sig + cp ../gitian.sigs/${VERSION}/${signer}/dogecoin-build.assert ./gitian/${signer}-build.assert + cp ../gitian.sigs/${VERSION}/${signer}/dogecoin-build.assert.sig ./gitian/${signer}-build.assert.sig done - zip -r dogecoin-${VERSION}-linux-gitian.zip * - cp dogecoin-${VERSION}-linux-gitian.zip ../ + zip -r bitcoin-${VERSION}-linux-gitian.zip * + cp bitcoin-${VERSION}-linux-gitian.zip ../ popd - mkdir dogecoin-${VERSION}-win-gitian - pushd dogecoin-${VERSION}-win-gitian + mkdir bitcoin-${VERSION}-win-gitian + pushd bitcoin-${VERSION}-win-gitian unzip ../dogecoin-${VERSION}-win-gitian.zip mkdir gitian - cp ../bitcoin/contrib/gitian-downloader/*.pgp ./gitian/ + cp ../dogecoin/contrib/gitian-downloader/*.pgp ./gitian/ for signer in $(ls ../gitian.sigs/${VERSION}-win/); do - cp ../gitian.sigs/${VERSION}-win/${signer}/bitcoin-build.assert ./gitian/${signer}-build.assert - cp ../gitian.sigs/${VERSION}-win/${signer}/bitcoin-build.assert.sig ./gitian/${signer}-build.assert.sig + cp ../gitian.sigs/${VERSION}-win/${signer}/dogecoin-build.assert ./gitian/${signer}-build.assert + cp ../gitian.sigs/${VERSION}-win/${signer}/dogecoin-build.assert.sig ./gitian/${signer}-build.assert.sig done - zip -r dogecoin-${VERSION}-win-gitian.zip * - cp dogecoin-${VERSION}-win-gitian.zip ../ + zip -r bitcoin-${VERSION}-win-gitian.zip * + cp bitcoin-${VERSION}-win-gitian.zip ../ popd - Upload gitian zips to SourceForge - Announce the release: - - Add the release to bitcoin.org: https://github.com/bitcoin/bitcoin.org/tree/master/_releases + - Add the release to dogecoin.com - - Release sticky on bitcointalk: https://bitcointalk.org/index.php?board=1.0 + - Announce on reddit /r/dogecoin, /r/dogecoindev - - Bitcoin-development mailing list - - - Optionally reddit /r/Bitcoin, ... + - Release sticky on bitcointalk: https://bitcointalk.org/index.php?board=67.0 - Celebrate diff --git a/doc/tor.md b/doc/tor.md index 46910b099..33378eadb 100644 --- a/doc/tor.md +++ b/doc/tor.md @@ -1,5 +1,5 @@ -TOR SUPPORT IN BITCOIN -====================== +TOR SUPPORT IN DOGECOIN +======================= It is possible to run Dogecoin as a Tor hidden service, and connect to such services. @@ -36,7 +36,7 @@ outgoing connections be anonymized, but more is possible. In a typical situation, this suffices to run behind a Tor proxy: - ./bitcoin -proxy=127.0.0.1:9050 + ./dogecoin -proxy=127.0.0.1:9050 2. Run a bitcoin hidden server @@ -46,17 +46,17 @@ If you configure your Tor system accordingly, it is possible to make your node a reachable from the Tor network. Add these lines to your /etc/tor/torrc (or equivalent config file): - HiddenServiceDir /var/lib/tor/bitcoin-service/ + HiddenServiceDir /var/lib/tor/dogecoin-service/ HiddenServicePort 22556 127.0.0.1:8333 HiddenServicePort 122556 127.0.0.1:18333 The directory can be different of course, but (both) port numbers should be equal to -your bitcoind's P2P listen port (22556 by default). +your dogecoind's P2P listen port (22556 by default). -externalip=X You can tell bitcoin about its publicly reachable address using this option, and this can be a .onion address. Given the above configuration, you can find your onion address in - /var/lib/tor/bitcoin-service/hostname. Onion addresses are given + /var/lib/tor/dogecoin-service/hostname. Onion addresses are given preference for your node to advertize itself with, for connections coming from unroutable addresses (such as 127.0.0.1, where the Tor proxy typically runs). @@ -73,18 +73,18 @@ your bitcoind's P2P listen port (22556 by default). In a typical situation, where you're only reachable via Tor, this should suffice: - ./bitcoind -proxy=127.0.0.1:9050 -externalip=57qr3yd1nyntf5k.onion -listen + ./dogecoind -proxy=127.0.0.1:9050 -externalip=57qr3yd1nyntf5k.onion -listen (obviously, replace the Onion address with your own). If you don't care too much about hiding your node, and want to be reachable on IPv4 as well, additionally specify: - ./bitcoind ... -discover + ./dogecoind ... -discover and open port 22556 on your firewall (or use -upnp). If you only want to use Tor to reach onion addresses, but not use it as a proxy for normal IPv4/IPv6 communication, use: - ./bitcoin -onion=127.0.0.1:9050 -externalip=57qr3yd1nyntf5k.onion -discover + ./dogecoin -onion=127.0.0.1:9050 -externalip=57qr3yd1nyntf5k.onion -discover diff --git a/doc/translation_process.md b/doc/translation_process.md index 9fb762286..1e1b0215f 100644 --- a/doc/translation_process.md +++ b/doc/translation_process.md @@ -12,7 +12,7 @@ Files and Folders This file takes care of generating `.qm` files from `.ts` files. It is mostly automated. -### src/qt/bitcoin.qrc +### src/qt/dogecoin.qrc This file must be updated whenever a new translation is added. Please note that files must end with `.qm`, not `.ts`. diff --git a/doc/unit-tests.md b/doc/unit-tests.md index f1d3a8bc5..46072af23 100644 --- a/doc/unit-tests.md +++ b/doc/unit-tests.md @@ -6,13 +6,13 @@ and tests weren't explicitly disabled. After configuring, they can be run with 'make check'. -To run the bitcoind tests manually, launch src/test/test_bitcoin . +To run the dogecoind tests manually, launch src/test/test_bitcoin . -To add more bitcoind tests, add `BOOST_AUTO_TEST_CASE` functions to the existing +To add more dogecoind tests, add `BOOST_AUTO_TEST_CASE` functions to the existing .cpp files in the test/ directory or add new .cpp files that implement new BOOST_AUTO_TEST_SUITE sections. -To run the bitcoin-qt tests manually, launch src/qt/test/bitcoin-qt_test +To run the dogecoin-qt tests manually, launch src/qt/test/bitcoin-qt_test -To add more bitcoin-qt tests, add them to the `src/qt/test/` directory and +To add more dogecoin-qt tests, add them to the `src/qt/test/` directory and the `src/qt/test/test_main.cpp` file.