Skip to content

Commit

Permalink
Markdown Cleanup - Part 2
Browse files Browse the repository at this point in the history
Now everything is in markdown...
  • Loading branch information
super3 committed Jun 16, 2013
1 parent e58154c commit 00a8874
Show file tree
Hide file tree
Showing 8 changed files with 394 additions and 62 deletions.
46 changes: 35 additions & 11 deletions doc/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
Bitcoin 0.8.2 BETA
Bitcoin 0.8.2 BETA
====================

Copyright (c) 2009-2013 Bitcoin Developers

Distributed under the MIT/X11 software license, see the accompanying
file COPYING or http://www.opensource.org/licenses/mit-license.php.
Distributed under the [MIT/X11 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](http://www.openssl.org/). This product includes
cryptographic software written by Eric Young ([[email protected]](mailto:[email protected])), and UPnP software written by Thomas Bernard.

Expand All @@ -19,8 +18,13 @@ with each other, with the help of a P2P network to check for double-spending.

Setup
---------------------
[Bitcoin-Qt](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; 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.

### Unix

You need the Qt4 run-time libraries to run Bitcoin-Qt. On Debian or Ubuntu:
`sudo apt-get install libqtgui4`

sudo apt-get install libqtgui4

Unpack the files into a directory and run:

Expand All @@ -29,18 +33,38 @@ Unpack the files into a directory and run:
- bin/64/bitcoin-qt (GUI, 64-bit)
- bin/64/bitcoind (headless, 64-bit)

See the documentation at the [Bitcoin Wiki](https://en.bitcoin.it/wiki/Main_Page)
for help and more information.


Other Pages
### Windows

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

### 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.

Building
---------------------
- [Unix Build Notes](build-unix.md)
- [Bitcoin-Qt Readme](readme-qt.md)
- [OSX Build Notes](build-osx.md)
- [Unix Build Notes](build-unix.md)
- [Windows Build Notes](build-msw.md)

Development
---------------------
- [Coding Guidelines](coding.md)
- [Release Process](release-process.md)
- [Release Notes](release-notes.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/)
- [Translation Process](translation_process.md)
- [Unit Tests](unit-tests.md)
- [Translation Process](translation_process.md)

Other Pages
---------------------
- [Assets Attribution](assets-attribution.md)
- [Files](files.md)
- [Tor Support](tor.md)
104 changes: 104 additions & 0 deletions doc/assets-attribution.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
The following is a list of assets used in the bitcoin source and their proper attribution.

[Wladimir van der Laan](https://github.com/laanwj)
-----------------------
#### Info
* License: MIT
### Assets Used

src/qt/res/icons/clock*.png, src/qt/res/icons/tx*.png,
src/qt/res/src/clock_green.svg, src/qt/res/src/clock1.svg,
src/qt/res/src/clock2.svg, src/qt/res/src/clock3.svg,
src/qt/res/src/clock4.svg, src/qt/res/src/clock5.svg,
src/qt/res/src/inout.svg, src/qt/res/src/questionmark.svg

[David Vignoni](www.icon-king.com)
-----------------------

### Info
* Icon Pack: NUVOLA ICON THEME for KDE 3.x
* Designer: David Vignoni ([email protected])
* License: LGPL
* Site: [http://www.icon-king.com/projects/nuvola/](http://www.icon-king.com/projects/nuvola/)

### Assets Used
src/qt/res/icons/address-book.png, src/qt/res/icons/export.png,
src/qt/res/icons/history.png, src/qt/res/icons/key.png,
src/qt/res/icons/lock_*.png, src/qt/res/icons/overview.png,
src/qt/res/icons/receive.png, src/qt/res/icons/send.png,
src/qt/res/icons/synced.png, src/qt/res/icons/filesave.png

schollidesign
-----------------------

### Info
* Icon Pack: Human-O2
* Designer: schollidesign
* License: GNU/GPL
* Site: [http://findicons.com/icon/93743/blocks_gnome_netstatus_0](http://findicons.com/icon/93743/blocks_gnome_netstatus_0)

### Assets Used
src/qt/res/icons/connect*.png

md2k7
-----------------------

### Info
* Designer: md2k7
* Site: https://bitcointalk.org/index.php?topic=15276.0
* License: You are free to do with these icons as you wish, including selling,
copying, modifying etc.
* License: MIT

### Assets Used
src/qt/res/icons/transaction*.png

[Everaldo.com](http://www.everaldo.com)
-----------------------

### Info
* Designer: [http://www.everaldo.com](http://www.everaldo.com)
* Icon Pack: Crystal SVG
* License: LGPL

### Assets Used
src/qt/res/icons/configure.png, src/qt/res/icons/quit.png,
src/qt/res/icons/editcopy.png, src/qt/res/icons/editpaste.png,
src/qt/res/icons/add.png, src/qt/res/icons/edit.png,
src/qt/res/icons/remove.png (edited)

Everaldo (Everaldo Coelho)
-----------------------

### Info
* Icon Pack: Kids
* Designer: Everaldo (Everaldo Coelho)
* License: GNU/GPL
* Site: [http://findicons.com/icon/17102/reload?id=17102](http://findicons.com/icon/17102/reload?id=17102)
### Assets Used
scripts/img/reload.xcf (modified), src/qt/res/movies/update_spinner.mng

[Vignoni David](http://www.oxygen-icons.org/)
-----------------------

### Info
* Designer: Vignoni David
* Site: http://www.oxygen-icons.org/
* License: Oxygen icon theme is dual licensed. You may copy it under the Creative Common Attribution-ShareAlike 3.0 License or the GNU Library General Public License.

### Assets Used
src/qt/res/icons/debugwindow.png

Jonas Schnelli
-----------------------

### Info
* Designer: Jonas Schnelli (based on the original bitcoin 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/toolbar.png, src/qt/res/icons/toolbar_testnet.png,
src/qt/res/images/splash.png, src/qt/res/images/splash_testnet.png
25 changes: 9 additions & 16 deletions doc/build-msw.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,9 @@
Copyright (c) 2009-2013 Bitcoin Developers

Distributed under the MIT/X11 software license, see the accompanying
file COPYING or http://www.opensource.org/licenses/mit-license.php.
This product includes software developed by the OpenSSL Project for use in the [OpenSSL Toolkit](http://www.openssl.org/). This product includes
cryptographic software written by Eric Young ([[email protected]](mailto:[email protected])), and UPnP software written by Thomas Bernard.


See readme-qt.rst for instructions on building Bitcoin-Qt, the
graphical user interface.

WINDOWS BUILD NOTES
===================

See [readme-qt.rst](readme-qt.rst) for instructions on building Bitcoin-Qt, the
graphical user interface.

Compilers Supported
-------------------
TODO: What works?
Expand All @@ -22,11 +14,12 @@ Dependencies
------------
Libraries you need to download separately and build:

default path download
OpenSSL \openssl-1.0.1c-mgw http://www.openssl.org/source/
Berkeley DB \db-4.8.30.NC-mgw http://www.oracle.com/technology/software/products/berkeley-db/index.html
Boost \boost-1.50.0-mgw http://www.boost.org/users/download/
miniupnpc \miniupnpc-1.6-mgw http://miniupnp.tuxfamily.org/files/
name default path download
--------------------------------------------------------------------------------------------------------------------
OpenSSL \openssl-1.0.1c-mgw http://www.openssl.org/source/
Berkeley DB \db-4.8.30.NC-mgw http://www.oracle.com/technology/software/products/berkeley-db/index.html
Boost \boost-1.50.0-mgw http://www.boost.org/users/download/
miniupnpc \miniupnpc-1.6-mgw http://miniupnp.tuxfamily.org/files/

Their licenses:

Expand Down
33 changes: 5 additions & 28 deletions doc/build-osx.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,15 @@
Mac OS X bitcoind build instructions
Mac OS X Build Instructions and Notes
====================================

Authors
-------

* Laszlo Hanyecz <[email protected]>
* Douglas Huff <[email protected]>
* Colin Dean <[email protected]>
* Gavin Andresen <[email protected]>

License
-------

Copyright (c) 2009-2012 Bitcoin Developers

Distributed under the MIT/X11 software license, see the accompanying
file COPYING or http://www.opensource.org/licenses/mit-license.php.

This product includes software developed by the OpenSSL Project for use in
the OpenSSL Toolkit (http://www.openssl.org/).

This product includes cryptographic software written by
Eric Young ([email protected]) and UPnP software written by Thomas Bernard.
This guide will show you how to build bitcoind(headless client) for OSX.

Notes
-----

See `doc/readme-qt.rst` for instructions on building Bitcoin-Qt, the
* See [readme-qt.rst](readme-qt.rst) for instructions on building Bitcoin-Qt, the
graphical user interface.

Tested on OS X 10.5 through 10.8 on Intel processors only. PPC is not
* Tested on OS X 10.5 through 10.8 on Intel processors only. PPC is not
supported because it is big-endian.

All of the commands should be executed in a Terminal application. The
* All of the commands should be executed in a Terminal application. The
built-in one is located in `/Applications/Utilities`.

Preparation
Expand Down
8 changes: 1 addition & 7 deletions doc/build-unix.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
Copyright (c) 2009-2013 Bitcoin Developers

Distributed under the MIT/X11 software license, see the accompanying
file COPYING or http://www.opensource.org/licenses/mit-license.php.
This product includes software developed by the OpenSSL Project for use in the [OpenSSL Toolkit](http://www.openssl.org/). This product includes
cryptographic software written by Eric Young ([[email protected]](mailto:[email protected])), and UPnP software written by Thomas Bernard.

UNIX BUILD NOTES
====================
Some notes on how to build Bitcoin in Unix.

To Build
---------------------
Expand Down
23 changes: 23 additions & 0 deletions doc/files.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
Used in 0.8.0
---------------------
* wallet.dat: personal wallet (BDB) with keys and transactions
* peers.dat: peer IP address database (custom format); since 0.7.0
* blocks/blk000??.dat: block data (custom, 128 MiB per file); since 0.8.0
* blocks/rev000??.dat; block undo data (custom); since 0.8.0 (format changed since pre-0.8)
* blocks/index/*; block index (LevelDB); since 0.8.0
* chainstate/*; block chain state database (LevelDB); since 0.8.0
* database/*: BDB database environment; only used for wallet since 0.8.0

Only used in pre-0.8.0
---------------------
* blktree/*; block chain index (LevelDB); since pre-0.8, replaced by blocks/index/* in 0.8.0
* coins/*; unspent transaction output database (LevelDB); since pre-0.8, replaced by chainstate/* in 0.8.0

Only used before 0.8.0
---------------------
* blkindex.dat: block chain index database (BDB); replaced by {chainstate/*,blocks/index/*,blocks/rev000??.dat} in 0.8.0
* blk000?.dat: block data (custom, 2 GiB per file); replaced by blocks/blk000??.dat in 0.8.0

Only used before 0.7.0
---------------------
* addr.dat: peer IP address database (BDB); replaced by peers.dat in 0.7.0
Loading

0 comments on commit 00a8874

Please sign in to comment.