Skip to content

Commit 9686459

Browse files
laanwjlaanwj
committed
Merge pull request #3123 from super3/master
Prettify some /Contrib READMEs
2 parents fcb9f26 + 14f870c commit 9686459

File tree

8 files changed

+35
-39
lines changed

8 files changed

+35
-39
lines changed

‎INSTALL

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
Building Bitcoin
22

3-
See doc/readme-qt.md for instructions on building Bitcoin-Qt,
4-
the intended-for-end-users, nice-graphical-interface, reference
5-
implementation of Bitcoin.
6-
73
See doc/build-*.md for instructions on building bitcoind,
84
the intended-for-services, no-graphical-interface, reference
95
implementation of Bitcoin.

‎contrib/README.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,23 @@
1-
Contrib Index
1+
Python Tools
22
---------------------
33

44
### [BitRPC](/contrib/bitrpc) ###
5-
Added bitrpc.py which allows for sending of all standard Bitcoin commands via RPC rather than as command line args.
5+
Allows for sending of all standard Bitcoin commands via RPC rather than as command line args.
6+
7+
### [PyMiner](/contrib/pyminer) ###
8+
9+
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.
10+
11+
### [SpendFrom](/contrib/spendfrom) ###
12+
13+
Use the raw transactions API to send coins received on a particular
14+
address (or addresses).
15+
16+
### [Wallet Tools](/contrib/wallettools) ###
17+
Contains a wallet change password and unlock script. Used to prevent users from having to enter their password as a command-line argument.
18+
19+
Repository Tools
20+
---------------------
621

722
### [Debian](/contrib/debian) ###
823
Contains files used to package bitcoind/bitcoin-qt
@@ -20,22 +35,13 @@ Construct a linear, no-fork, best version of the blockchain.
2035
### [MacDeploy](/contrib/macdeploy) ###
2136
Scripts and notes for Mac builds.
2237

23-
### [PyMiner](/contrib/pyminer) ###
24-
25-
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.
26-
2738
### [Qos](/contrib/qos) ###
2839

2940
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.
3041

3142
### [Seeds](/contrib/seeds) ###
3243
Utility to generate the pnSeed[] array that is compiled into the client.
3344

34-
### [SpendFrom](/contrib/spendfrom) ###
35-
36-
Use the raw transactions API to send coins received on a particular
37-
address (or addresses).
38-
3945
### [TestGen](/contrib/testgen) ###
4046
Utilities to generate test vectors for the data-driven Bitcoin tests.
4147

@@ -46,5 +52,3 @@ tests each pull and when master is tested using jenkins.
4652
### [Verify SF Binaries](/contrib/verifysfbinaries) ###
4753
This script attempts to download and verify the signature file SHA256SUMS.asc from SourceForge.
4854

49-
### [Wallet Tools](/contrib/wallettools) ###
50-
Contains a wallet change password and unlock script.

‎contrib/pyminer/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
### PyMiner ###
22

3-
This is a 'getwork' CPU mining client for Bitcoin.
3+
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.
44

5-
It is pure-python, and therefore very, very slow. The purpose is to
6-
provide a reference implementation of a miner, for study.
5+
### Other Resources ###
76

7+
- [BitcoinTalk Thread](https://bitcointalk.org/index.php?topic=3546.0)
8+
- [Jgarzik Repo](https://github.com/jgarzik/pyminer)

‎contrib/spendfrom/README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
### SpendFrom ###
22

33
Use the raw transactions API to send coins received on a particular
4-
address (or addresses).
4+
address (or addresses).
55

6-
Depends on `jsonrpc`
7-
8-
Usage:
6+
### Usage: ###
7+
Depends on [jsonrpc](http://json-rpc.org/).
98

109
spendfrom.py --from=FROMADDRESS1[,FROMADDRESS2] --to=TOADDRESS --amount=amount \
1110
--fee=fee --datadir=/path/to/.bitcoin --testnet --dry_run
@@ -14,21 +13,23 @@ With no arguments, outputs a list of amounts associated with addresses.
1413

1514
With arguments, sends coins received by the `FROMADDRESS` addresses to the `TOADDRESS`.
1615

17-
You may explictly specify how much fee to pay (a fee more than 1% of the amount
16+
### Notes ###
17+
18+
- You may explictly specify how much fee to pay (a fee more than 1% of the amount
1819
will fail, though, to prevent bitcoin-losing accidents). Spendfrom may fail if
1920
it thinks the transaction would never be confirmed (if the amount being sent is
2021
too small, or if the transaction is too many bytes for the fee).
2122

22-
If a change output needs to be created, the change will be sent to the last
23+
- If a change output needs to be created, the change will be sent to the last
2324
`FROMADDRESS` (if you specify just one `FROMADDRESS`, change will go back to it).
2425

25-
If `--datadir` is not specified, the default datadir is used.
26+
- If `--datadir` is not specified, the default datadir is used.
2627

27-
The `--dry_run` option will just create and sign the the transaction and print
28+
- The `--dry_run` option will just create and sign the the transaction and print
2829
the transaction data (as hexadecimal), instead of broadcasting it.
2930

30-
If the transaction is created and broadcast successfully, a transaction id
31+
- If the transaction is created and broadcast successfully, a transaction id
3132
is printed.
3233

33-
If this was a tool for end-users and not programmers, it would have much friendlier
34+
- If this was a tool for end-users and not programmers, it would have much friendlier
3435
error-handling.

‎contrib/verifysfbinaries/README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
### Verify SF Binaries ###
22
This script attempts to download the signature file `SHA256SUMS.asc` from SourceForge.
33

4-
It first checks if the signature passes, and then downloads the files specified in
5-
the file, and checks if the hashes of these files match those that are specified
6-
in the signature file. The script returns 0 if everything passes the checks. It returns 1 if either the
7-
signature check or the hash check doesn't pass. If an error occurs the return value is 2
4+
It first checks if the signature passes, and then downloads the files specified in the file, and checks if the hashes of these files match those that are specified in the signature file.
5+
6+
The script returns 0 if everything passes the checks. It returns 1 if either the signature check or the hash check doesn't pass. If an error occurs the return value is 2.

‎doc/build-msw.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
WINDOWS BUILD NOTES
22
===================
33

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

75
Compilers Supported
86
-------------------

‎doc/build-osx.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ This guide will show you how to build bitcoind(headless client) for OSX.
55
Notes
66
-----
77

8-
* See [readme-qt.md](readme-qt.md) for instructions on building Bitcoin-Qt, the
9-
graphical user interface.
108
* Tested on OS X 10.5 through 10.8 on Intel processors only. PPC is not
119
supported because it is big-endian.
1210
* All of the commands should be executed in a Terminal application. The

‎doc/build-unix.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ To Build
1010
make
1111

1212
This will build bitcoin-qt as well if the dependencies are met.
13-
See [readme-qt.md](readme-qt.md) for more information.
1413

1514
Dependencies
1615
---------------------

0 commit comments

Comments
 (0)