Permalink
Browse files

Prettify some /Contrib READMEs

SYN

Remove Dead Readme-Qt Links.
  • Loading branch information...
1 parent db0e8cc commit 14f870cee50f791bfa9c08bf1d60f8a3b9aeab23 @super3 super3 committed Oct 22, 2013
Showing with 35 additions and 39 deletions.
  1. +0 −4 INSTALL
  2. +17 −13 contrib/README.md
  3. +4 −3 contrib/pyminer/README.md
  4. +11 −10 contrib/spendfrom/README.md
  5. +3 −4 contrib/verifysfbinaries/README.md
  6. +0 −2 doc/build-msw.md
  7. +0 −2 doc/build-osx.md
  8. +0 −1 doc/build-unix.md
View
@@ -1,9 +1,5 @@
Building Bitcoin
-See doc/readme-qt.md for instructions on building Bitcoin-Qt,
-the intended-for-end-users, nice-graphical-interface, reference
-implementation of Bitcoin.
-
See doc/build-*.md for instructions on building bitcoind,
the intended-for-services, no-graphical-interface, reference
implementation of Bitcoin.
View
@@ -1,8 +1,23 @@
-Contrib Index
+Python Tools
---------------------
### [BitRPC](/contrib/bitrpc) ###
-Added bitrpc.py which allows for sending of all standard Bitcoin commands via RPC rather than as command line args.
+Allows for sending of all standard Bitcoin commands via RPC rather than as command line args.
+
+### [PyMiner](/contrib/pyminer) ###
+
+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.
+
+### [SpendFrom](/contrib/spendfrom) ###
+
+Use the raw transactions API to send coins received on a particular
+address (or addresses).
+
+### [Wallet Tools](/contrib/wallettools) ###
+Contains a wallet change password and unlock script. Used to prevent users from having to enter their password as a command-line argument.
+
+Repository Tools
+---------------------
### [Debian](/contrib/debian) ###
Contains files used to package bitcoind/bitcoin-qt
@@ -20,22 +35,13 @@ Construct a linear, no-fork, best version of the blockchain.
### [MacDeploy](/contrib/macdeploy) ###
Scripts and notes for Mac builds.
-### [PyMiner](/contrib/pyminer) ###
-
-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.
-
### [Qos](/contrib/qos) ###
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.
### [Seeds](/contrib/seeds) ###
Utility to generate the pnSeed[] array that is compiled into the client.
-### [SpendFrom](/contrib/spendfrom) ###
-
-Use the raw transactions API to send coins received on a particular
-address (or addresses).
-
### [TestGen](/contrib/testgen) ###
Utilities to generate test vectors for the data-driven Bitcoin tests.
@@ -46,5 +52,3 @@ tests each pull and when master is tested using jenkins.
### [Verify SF Binaries](/contrib/verifysfbinaries) ###
This script attempts to download and verify the signature file SHA256SUMS.asc from SourceForge.
-### [Wallet Tools](/contrib/wallettools) ###
-Contains a wallet change password and unlock script.
@@ -1,7 +1,8 @@
### PyMiner ###
-This is a 'getwork' CPU mining client for Bitcoin.
+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.
-It is pure-python, and therefore very, very slow. The purpose is to
-provide a reference implementation of a miner, for study.
+### Other Resources ###
+- [BitcoinTalk Thread](https://bitcointalk.org/index.php?topic=3546.0)
+- [Jgarzik Repo](https://github.com/jgarzik/pyminer)
@@ -1,11 +1,10 @@
### SpendFrom ###
Use the raw transactions API to send coins received on a particular
-address (or addresses).
+address (or addresses).
-Depends on `jsonrpc`
-
-Usage:
+### Usage: ###
+Depends on [jsonrpc](http://json-rpc.org/).
spendfrom.py --from=FROMADDRESS1[,FROMADDRESS2] --to=TOADDRESS --amount=amount \
--fee=fee --datadir=/path/to/.bitcoin --testnet --dry_run
@@ -14,21 +13,23 @@ With no arguments, outputs a list of amounts associated with addresses.
With arguments, sends coins received by the `FROMADDRESS` addresses to the `TOADDRESS`.
-You may explictly specify how much fee to pay (a fee more than 1% of the amount
+### Notes ###
+
+- You may explictly specify how much fee to pay (a fee more than 1% of the amount
will fail, though, to prevent bitcoin-losing accidents). Spendfrom may fail if
it thinks the transaction would never be confirmed (if the amount being sent is
too small, or if the transaction is too many bytes for the fee).
-If a change output needs to be created, the change will be sent to the last
+- If a change output needs to be created, the change will be sent to the last
`FROMADDRESS` (if you specify just one `FROMADDRESS`, change will go back to it).
-If `--datadir` is not specified, the default datadir is used.
+- If `--datadir` is not specified, the default datadir is used.
-The `--dry_run` option will just create and sign the the transaction and print
+- The `--dry_run` option will just create and sign the the transaction and print
the transaction data (as hexadecimal), instead of broadcasting it.
-If the transaction is created and broadcast successfully, a transaction id
+- If the transaction is created and broadcast successfully, a transaction id
is printed.
-If this was a tool for end-users and not programmers, it would have much friendlier
+- If this was a tool for end-users and not programmers, it would have much friendlier
error-handling.
@@ -1,7 +1,6 @@
### Verify SF Binaries ###
This script attempts to download the signature file `SHA256SUMS.asc` from SourceForge.
-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. 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
+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.
+
+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.
View
@@ -1,8 +1,6 @@
WINDOWS BUILD NOTES
===================
-See [readme-qt.md](readme-qt.md) for instructions on building Bitcoin-Qt, the
-graphical user interface.
Compilers Supported
-------------------
View
@@ -5,8 +5,6 @@ This guide will show you how to build bitcoind(headless client) for OSX.
Notes
-----
-* See [readme-qt.md](readme-qt.md) 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
supported because it is big-endian.
* All of the commands should be executed in a Terminal application. The
View
@@ -10,7 +10,6 @@ To Build
make
This will build bitcoin-qt as well if the dependencies are met.
-See [readme-qt.md](readme-qt.md) for more information.
Dependencies
---------------------

0 comments on commit 14f870c

Please sign in to comment.