diff options
| -rw-r--r-- | INSTALL | 4 | ||||
| -rw-r--r-- | contrib/README.md | 30 | ||||
| -rw-r--r-- | contrib/pyminer/README.md | 7 | ||||
| -rw-r--r-- | contrib/spendfrom/README.md | 21 | ||||
| -rw-r--r-- | contrib/verifysfbinaries/README.md | 7 | ||||
| -rw-r--r-- | doc/build-msw.md | 2 | ||||
| -rw-r--r-- | doc/build-osx.md | 2 | ||||
| -rw-r--r-- | doc/build-unix.md | 1 |
8 files changed, 35 insertions, 39 deletions
@@ -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.
\ No newline at end of file diff --git a/contrib/README.md b/contrib/README.md index 7128fd5eb0..eb0d3ee2c9 100644 --- a/contrib/README.md +++ b/contrib/README.md @@ -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,10 +35,6 @@ 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. @@ -31,11 +42,6 @@ A Linux bash script that will set up tc to limit the outgoing bandwidth for conn ### [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. diff --git a/contrib/pyminer/README.md b/contrib/pyminer/README.md index 119d51bdc7..3b20f2fdea 100644 --- a/contrib/pyminer/README.md +++ b/contrib/pyminer/README.md @@ -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)
\ No newline at end of file diff --git a/contrib/spendfrom/README.md b/contrib/spendfrom/README.md index bc4def5f74..809540b7b1 100644 --- a/contrib/spendfrom/README.md +++ b/contrib/spendfrom/README.md @@ -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. diff --git a/contrib/verifysfbinaries/README.md b/contrib/verifysfbinaries/README.md index caa4073605..f646d1efd1 100644 --- a/contrib/verifysfbinaries/README.md +++ b/contrib/verifysfbinaries/README.md @@ -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
\ No newline at end of file +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.
\ No newline at end of file diff --git a/doc/build-msw.md b/doc/build-msw.md index d348ad7cc3..e7e902eaa5 100644 --- a/doc/build-msw.md +++ b/doc/build-msw.md @@ -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 ------------------- diff --git a/doc/build-osx.md b/doc/build-osx.md index 271f8f55bd..6ded75d340 100644 --- a/doc/build-osx.md +++ b/doc/build-osx.md @@ -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 diff --git a/doc/build-unix.md b/doc/build-unix.md index 422b46cc3a..59a036f4a8 100644 --- a/doc/build-unix.md +++ b/doc/build-unix.md @@ -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 --------------------- |