Skip to content

Commit

Permalink
adapted documentation to feathercoin
Browse files Browse the repository at this point in the history
  • Loading branch information
wellenreiter01 committed Aug 18, 2015
1 parent ceebac0 commit 2a7cdd8
Show file tree
Hide file tree
Showing 16 changed files with 194 additions and 190 deletions.
6 changes: 3 additions & 3 deletions doc/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ DOXYFILE_ENCODING = UTF-8
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.

PROJECT_NAME = Bitcoin
PROJECT_NAME = Feathercoin

# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
# if some version control system is used.

PROJECT_NUMBER = 0.9.99
PROJECT_NUMBER = 0.9.3

# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer
Expand All @@ -47,7 +47,7 @@ PROJECT_BRIEF = "P2P Digital Currency"
# exceed 55 pixels and the maximum width should not exceed 200 pixels.
# Doxygen will copy the logo to the output directory.

PROJECT_LOGO = doc/bitcoin_logo_doxygen.png
PROJECT_LOGO = doc/feathercoin_logo_doxygen.png

# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
Expand Down
44 changes: 20 additions & 24 deletions doc/README.md
Original file line number Diff line number Diff line change
@@ -1,73 +1,69 @@
Bitcoin 0.9.0 BETA
Feathercoin 0.9.0 BETA
=====================

Copyright (c) 2009-2014 Bitcoin Developers
Copyright (c) 2009-2014 Feathercoin Developers


Setup
---------------------
[Bitcoin Core](http://bitcoin.org/en/download) is the original Bitcoin client and it builds the backbone of the network. However, it downloads and stores the entire history of Bitcoin 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).
[Feathercoin Core] is the original Feathercoin client and it builds the backbone of the network. However, it downloads and stores the entire history of Feathercoin 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
---------------------
The following are some helpful notes on how to run Bitcoin on your native platform.
The following are some helpful notes on how to run Feathercoin on your native platform.

### Unix

You need the Qt4 run-time libraries to run Bitcoin-Qt. On Debian or Ubuntu:
You need the Qt5 run-time libraries to run Feathercoin-Qt.
You also need the zxing (Zebra Crossing) libraries for qrcode support.
The libraries should be installed by your package manager,if you use an installation package for you distribution.

sudo apt-get install libqtgui4
If you need to compile or install the zxing libraries yourself, download the sources from github.com.
Search for zxing-cpp to get the c++ version of the code.

Unpack the files into a directory and run:

- bin/32/bitcoin-qt (GUI, 32-bit) or bin/32/bitcoind (headless, 32-bit)
- bin/64/bitcoin-qt (GUI, 64-bit) or bin/64/bitcoind (headless, 64-bit)



### Windows

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

### OSX

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

### Need Help?

* See the documentation at the [Bitcoin Wiki](https://en.bitcoin.it/wiki/Main_Page)
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 support in the support section of https://forum.feathercoin.com
* If you find a bug, you also may raise an issue at: http://www.github.com/Feathercoin/Feathercoin/issues

Building
---------------------
The following are developer notes on how to build Bitcoin on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc.
The developer documentation can be found on http://www.github.com/Feathercoin/Feathercoin/tree/0.9.3/doc

check for

- [OSX Build Notes](build-osx.md)
- [Unix Build Notes](build-unix.md)
- [Windows Build Notes](build-msw.md)

Development
---------------------
The Bitcoin repo's [root README](https://github.com/bitcoin/bitcoin/blob/master/README.md) contains relevant information on the development process and automated testing.
The Feathercoin repo's [root README](https://github.com/Feathercoin/Feathercoin/tree/0.9.3/README.md) contains relevant information on the development process and automated testing.

- [Coding Guidelines](coding.md)
- [Multiwallet Qt Development](multiwallet-qt.md)
- [Release Notes](release-notes.md)
- [Release Process](release-process.md)
- [Source Code Documentation (External Link)](https://dev.visucore.com/bitcoin/doxygen/)
- [Source Code Documentation (External Link)](https://dev.visucore.com/feathercoin/doxygen/)
- [Translation Process](translation_process.md)
- [Unit Tests](unit-tests.md)

### Resources
* Discuss on the [BitcoinTalk](https://bitcointalk.org/) forums, in the [Development & Technical Discussion board](https://bitcointalk.org/index.php?board=6.0).
* Discuss on [#bitcoin-dev](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-dev).
- forum.feathercoin.comp
- chat: forum.feathercoin.com/shoutbox

### Miscellaneous
- [Assets Attribution](assets-attribution.md)
- [Files](files.md)
- [Tor Support](tor.md)

License
---------------------
Expand Down
15 changes: 6 additions & 9 deletions doc/README_windows.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Bitcoin 0.9.0rc1 BETA
Feathercoin 0.9.3 Beta BETA

Copyright (c) 2009-2014 Bitcoin Core Developers
Copyright (c) 2009-2014 Feathercoin Core Developers

Distributed under the MIT/X11 software license, see the accompanying
file COPYING or http://www.opensource.org/licenses/mit-license.php.
Expand All @@ -11,21 +11,18 @@ cryptographic software written by Eric Young (eay@cryptsoft.com).

Intro
-----
Bitcoin is a free open source peer-to-peer electronic cash system that is
Feathercoin is a free open source peer-to-peer electronic cash system that is
completely decentralized, without the need for a central server or trusted
parties. Users hold the crypto keys to their own money and transact directly
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 feathercoin-qt.exe.

Bitcoin Core is the original Bitcoin client and it builds the backbone of the network.
However, it downloads and stores the entire history of Bitcoin transactions;
Feathercoin Core is the original Feathercoin client and it builds the backbone of the network.
However, it downloads and stores the entire history of Feathercoin transactions;
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.

See the bitcoin wiki at:
https://en.bitcoin.it/wiki/Main_Page
for more help and information.
12 changes: 6 additions & 6 deletions doc/assets-attribution.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
The following is a list of assets used in the bitcoin source and their proper attribution.
The following is a list of assets used in the feathercoin source and their proper attribution.

[Wladimir van der Laan](https://github.com/laanwj)
-----------------------
Expand Down Expand Up @@ -47,7 +47,7 @@ md2k7
* Designer: md2k7
* License: You are free to do with these icons as you wish, including selling, copying, modifying etc.
* License: MIT
* Site: [https://bitcointalk.org/index.php?topic=15276.0](https://bitcointalk.org/index.php?topic=15276.0)
* Site: [https://feathercointalk.org/index.php?topic=15276.0](https://feathercointalk.org/index.php?topic=15276.0)

### Assets Used
src/qt/res/icons/transaction*.png
Expand Down Expand Up @@ -93,12 +93,12 @@ Jonas Schnelli
-----------------------

### Info
* Designer: Jonas Schnelli (based on the original bitcoin logo from Bitboy)
* Designer: Jonas Schnelli (based on the original feathercoin logo from Bitboy)
* 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/feathercoin.icns, src/qt/res/src/feathercoin.svg,
src/qt/res/src/feathercoin.ico, src/qt/res/src/feathercoin.png,
src/qt/res/src/feathercoin_testnet.png, docs/feathercoin_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
Binary file removed doc/bitcoin_logo_doxygen.png
Binary file not shown.
2 changes: 1 addition & 1 deletion doc/coding.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,6 @@ Threads

- ThreadRPCServer : Remote procedure call handler, listens on port 8332 for connections and services them.

- BitcoinMiner : Generates bitcoins (if wallet is enabled).
- FeathercoinMiner : Generates feathercoins (if wallet is enabled).

- Shutdown : Does an orderly shutdown of everything.
28 changes: 14 additions & 14 deletions doc/multiwallet-qt.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,40 @@
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 feathercoin-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
implemented in the BitcoinGUI class moved over to these new classes.
implemented in the FeathercoinGUI class moved over to these new classes.

The two existing files most affected, by far, are bitcoingui.h and bitcoingui.cpp, as the BitcoinGUI class will require
The two existing files most affected, by far, are feathercoingui.h and feathercoingui.cpp, as the FeathercoinGUI class will require
some major retrofitting.

Only requiring some minor changes is bitcoin.cpp.
Only requiring some minor changes is feathercoin.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 feathercoin-qt.pro.

Changes to class BitcoinGUI
Changes to class FeathercoinGUI
---------------------------
The principal change to the BitcoinGUI class concerns the QStackedWidget instance called centralWidget.
The principal change to the FeathercoinGUI class concerns the QStackedWidget instance called centralWidget.
This widget owns five page views: overviewPage, transactionsPage, addressBookPage, receiveCoinsPage, and sendCoinsPage.

A new class called *WalletView* inheriting from QStackedWidget has been written to handle all renderings and updates of
these page views. In addition to owning these five page views, a WalletView also has a pointer to a WalletModel instance.
This allows the construction of multiple WalletView objects, each rendering a distinct wallet.

A second class called *WalletFrame* inheriting from QFrame has been written as a container for embedding all wallet-related
controls into BitcoinGUI. At present it contains the WalletView instances for the wallets and does little more than passing on messages
from BitcoinGUI to the currently selected WalletView. It is a WalletFrame instance
that takes the place of what used to be centralWidget in BitcoinGUI. The purpose of this class is to allow future
refinements of the wallet controls with minimal need for further modifications to BitcoinGUI, thus greatly simplifying
controls into FeathercoinGUI. At present it contains the WalletView instances for the wallets and does little more than passing on messages
from FeathercoinGUI to the currently selected WalletView. It is a WalletFrame instance
that takes the place of what used to be centralWidget in FeathercoinGUI. The purpose of this class is to allow future
refinements of the wallet controls with minimal need for further modifications to FeathercoinGUI, thus greatly simplifying
merges while reducing the risk of breaking top-level stuff.

Changes to bitcoin.cpp
Changes to feathercoin.cpp
----------------------
bitcoin.cpp is the entry point into bitcoin-qt, and as such, will require some minor modifications to provide hooks for
feathercoin.cpp is the entry point into feathercoin-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.
singleton FeathercoinGUI instance called window. Formerly, FeathercoinGUI 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
following two steps:

Expand Down
Loading

0 comments on commit 2a7cdd8

Please sign in to comment.