Skip to content

Commit 0aa9851

Browse files
committed
Documentation Cleanup in /Doc
Added some help text, and bumped version numbers. Added a Readable Index for /Contrib Fixing /Contrib Index URLs Revert Version Numbers.
1 parent c74b6c3 commit 0aa9851

File tree

6 files changed

+67
-39
lines changed

6 files changed

+67
-39
lines changed

README.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ the Bitcoin client software, see http://www.bitcoin.org.
2020
License
2121
-------
2222

23-
Bitcoin is released under the terms of the MIT license. See `COPYING` for more
23+
Bitcoin is released under the terms of the MIT license. See [COPYING](COPYING) for more
2424
information or see http://opensource.org/licenses/MIT.
2525

2626
Development process
@@ -38,7 +38,7 @@ submitter will be asked to start a discussion (if they haven't already) on the
3838

3939
The patch will be accepted if there is broad consensus that it is a good thing.
4040
Developers should expect to rework and resubmit patches if the code doesn't
41-
match the project's coding conventions (see `doc/coding.md`) or are
41+
match the project's coding conventions (see [doc/coding.md](doc/coding.md)) or are
4242
controversial.
4343

4444
The `master` branch is regularly built and tested, but is not guaranteed to be
@@ -56,10 +56,7 @@ lots of money.
5656
### Automated Testing
5757

5858
Developers are strongly encouraged to write unit tests for new code, and to
59-
submit new unit tests for old code.
60-
61-
Unit tests can be compiled and run (assuming they weren't disabled in configure) with:
62-
make check
59+
submit new unit tests for old code. Unit tests can be compiled and run (assuming they weren't disabled in configure) with: `make check`
6360

6461
Every pull request is built for both Windows and Linux on a dedicated server,
6562
and unit and sanity tests are automatically run. The binaries produced may be
@@ -71,5 +68,4 @@ for the build/test scripts.
7168

7269
Large changes should have a test plan, and should be tested by somebody other
7370
than the developer who wrote the code.
74-
7571
See https://github.com/bitcoin/QA/ for how to create a test plan.

contrib/README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
Contrib Index
2+
---------------------
3+
4+
### [Debian](/contrib/debian) ###
5+
Contains files used to package bitcoind/bitcoin-qt
6+
for Debian-based Linux systems. If you compile bitcoind/bitcoin-qt yourself, there are some useful files here.
7+
8+
### [Gitian-descriptors](/contrib/gitian-descriptors) ###
9+
Gavin's notes on getting gitian builds up and running using KVM.
10+
11+
### [Gitian-downloader](/contrib/gitian-downloader)
12+
Various PGP files of core developers.
13+
14+
### [Macdeploy](/contrib/macdeploy) ###
15+
Scripts and notes for Mac builds.
16+
17+
### [PyMiner](/contrib/pyminer) ###
18+
19+
This is a 'getwork' CPU mining client for Bitcoin. It is pure-python, and therefore very, very slow. The purpose is to provide a reference implementation of a miner, for study.
20+
21+
### [Qos](/contrib/qos) ###
22+
23+
A Linux bash script that will set up tc to limit the outgoing bandwidth for connections to the Bitcoin network. This means one can have an always-on bitcoind instance running, and another local bitcoind/bitcoin-qt instance which connects to this node and receives blocks from it.
24+
25+
### [Seeds](/contrib/seeds) ###
26+
Utility to generate the pnSeed[] array that is compiled into the client.
27+
28+
### [SpendFrom](/contrib/spendfrom) ###
29+
30+
Use the raw transactions API to send coins received on a particular
31+
address (or addresses).
32+
33+
### [TestGen](/contrib/testgen) ###
34+
Utilities to generate test vectors for the data-driven Bitcoin tests.

contrib/debian/README

Lines changed: 0 additions & 20 deletions
This file was deleted.

contrib/debian/README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
2+
Debian
3+
====================
4+
This directory contains files used to package bitcoind/bitcoin-qt
5+
for Debian-based Linux systems. If you compile bitcoind/bitcoin-qt yourself, there are some useful files here.
6+
7+
## bitcoin: URI support ##
8+
9+
10+
bitcoin-qt.desktop (Gnome / Open Desktop)
11+
To install:
12+
13+
sudo desktop-file-install bitcoin-qt.desktop
14+
sudo update-desktop-database
15+
16+
If you build yourself, you will either need to modify the paths in
17+
the .desktop file or copy or symlink your bitcoin-qt binary to `/usr/bin`
18+
and the `../../share/pixmaps/bitcoin128.png` to `/usr/share/pixmaps`
19+
20+
bitcoin-qt.protocol (KDE)
21+

contrib/testgen/README

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Utilities to generate test vectors for the data-driven Bitcoin tests
1+
Utilities to generate test vectors for the data-driven Bitcoin tests.

doc/README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,15 @@ Bitcoin 0.8.2 BETA
33

44
Copyright (c) 2009-2013 Bitcoin Developers
55

6+
License
7+
---------------------
68
Distributed under the [MIT/X11 software license](http://www.opensource.org/licenses/mit-license.php).
79
This product includes software developed by the OpenSSL Project for use in the [OpenSSL Toolkit](http://www.openssl.org/). This product includes
810
cryptographic software written by Eric Young ([[email protected]](mailto:[email protected])), and UPnP software written by Thomas Bernard.
911

10-
11-
Intro
12-
---------------------
13-
Bitcoin is a free open source peer-to-peer electronic cash system that is
14-
completely decentralized, without the need for a central server or trusted
15-
parties. Users hold the crypto keys to their own money and transact directly
16-
with each other, with the help of a P2P network to check for double-spending.
17-
18-
1912
Setup
2013
---------------------
21-
[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.
14+
[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 (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.
2215

2316
### Unix
2417

@@ -44,17 +37,21 @@ Unpack the files into a directory and run bitcoin-qt.exe.
4437
* See the documentation at the [Bitcoin Wiki](https://en.bitcoin.it/wiki/Main_Page)
4538
for help and more information.
4639
* 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).
47-
* Ask for help on the [BitcoinTalk](https://bitcointalk.org/) forums.
40+
* Ask for help on the [BitcoinTalk](https://bitcointalk.org/) forums, in the [technical support board](https://bitcointalk.org/index.php?board=4.0).
4841

4942
Building
5043
---------------------
44+
The following are developer notes on how to build Bitcoin on your native platform. They are not complete guide, but include notes on the necessary libraries, compile flags, etc.
45+
5146
- [Bitcoin-Qt Readme](readme-qt.md)
5247
- [OSX Build Notes](build-osx.md)
5348
- [Unix Build Notes](build-unix.md)
5449
- [Windows Build Notes](build-msw.md)
5550

5651
Development
5752
---------------------
53+
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.
54+
5855
- [Coding Guidelines](coding.md)
5956
- [Multiwallet Qt Development](multiwallet-qt.md)
6057
- [Release Notes](release-notes.md)

0 commit comments

Comments
 (0)