bitcoin/contrib/README.md

Repository Tools
---------------------

### [Developer tools](/contrib/devtools) ###
Specific tools for developers working on this repository.
Additional tools, including the `github-merge.py` script, are available in the [maintainer-tools](https://github.com/bitcoin-core/bitcoin-maintainer-tools) repository.

### [Verify-Commits](/contrib/verify-commits) ###
Tool to verify that every merge commit was signed by a developer using the `github-merge.py` script.

### [Linearize](/contrib/linearize) ###
Construct a linear, no-fork, best version of the blockchain.

### [Qos](/contrib/qos) ###

A Linux bash script that will set up traffic control (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.

Build Tools and Keys
---------------------

### Packaging ###
The [Debian](/contrib/debian) subfolder contains the copyright file.

All other packaging related files can be found in the [bitcoin-core/packaging](https://github.com/bitcoin-core/packaging) repository.

### [MacDeploy](/contrib/macdeploy) ###
Scripts and notes for Mac builds.

Test and Verify Tools
---------------------

### [TestGen](/contrib/testgen) ###
Utilities to generate test vectors for the data-driven Bitcoin tests.

### [Verify-Binaries](/contrib/verify-binaries) ###
This script attempts to download and verify the signature file SHA256SUMS.asc from bitcoin.org.

Command Line Tools
---------------------

### [Completions](/contrib/completions) ###
Shell completions for bash and fish.

UTXO Set Tools
--------------

### [UTXO-to-SQLite](/contrib/utxo-tools/utxo_to_sqlite.py) ###
This script converts a compact-serialized UTXO set (as generated by Bitcoin Core with `dumptxoutset`)
to a SQLite3 database. For more details like e.g. the created table name and schema, refer to the
module docstring on top of the script, which is also contained in the command's `--help` output.
/contrib index reorg Cleaner and easier to read. Reordered by functionality 2014-04-12 02:46:55 -04:00			`Repository Tools`
			`---------------------`

			`### [Developer tools](/contrib/devtools) ###`
			`Specific tools for developers working on this repository.`
scripts: remove github-merge.py This script has been moved to the bitcoin-core/bitcoin-maintainer-tools repository, after discussion in a core dev meeting. The rationale being that it is also useful to other projects, and thus should be moved to a more general repository. Meeting log: http://www.erisian.com.au/bitcoin-core-dev/log-2019-08-15.html See also: https://github.com/bitcoin-core/bitcoin-maintainer-tools/pull/28 2019-08-16 08:20:39 +08:00			Additional tools, including the `github-merge.py` script, are available in the [maintainer-tools](https://github.com/bitcoin-core/bitcoin-maintainer-tools) repository.
/contrib index reorg Cleaner and easier to read. Reordered by functionality 2014-04-12 02:46:55 -04:00
Add script to verify all merge commits are signed 2014-10-27 00:07:25 -07:00			`### [Verify-Commits](/contrib/verify-commits) ###`
scripts: remove github-merge.py This script has been moved to the bitcoin-core/bitcoin-maintainer-tools repository, after discussion in a core dev meeting. The rationale being that it is also useful to other projects, and thus should be moved to a more general repository. Meeting log: http://www.erisian.com.au/bitcoin-core-dev/log-2019-08-15.html See also: https://github.com/bitcoin-core/bitcoin-maintainer-tools/pull/28 2019-08-16 08:20:39 +08:00			Tool to verify that every merge commit was signed by a developer using the `github-merge.py` script.
Add script to verify all merge commits are signed 2014-10-27 00:07:25 -07:00
/contrib index reorg Cleaner and easier to read. Reordered by functionality 2014-04-12 02:46:55 -04:00			`### [Linearize](/contrib/linearize) ###`
			`Construct a linear, no-fork, best version of the blockchain.`

			`### [Qos](/contrib/qos) ###`
Prettify some /Contrib READMEs SYN Remove Dead Readme-Qt Links. 2013-10-21 20:00:10 -04:00
Update README.md Added two modifications to make the descriptions more clear. 2014-07-18 15:04:54 -04:00			`A Linux bash script that will set up traffic control (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.`
Prettify some /Contrib READMEs SYN Remove Dead Readme-Qt Links. 2013-10-21 20:00:10 -04:00
/contrib index reorg Cleaner and easier to read. Reordered by functionality 2014-04-12 02:46:55 -04:00			`### [Seeds](/contrib/seeds) ###`
			`Utility to generate the pnSeed[] array that is compiled into the client.`
Prettify some /Contrib READMEs SYN Remove Dead Readme-Qt Links. 2013-10-21 20:00:10 -04:00
/contrib index reorg Cleaner and easier to read. Reordered by functionality 2014-04-12 02:46:55 -04:00			`Build Tools and Keys`
Prettify some /Contrib READMEs SYN Remove Dead Readme-Qt Links. 2013-10-21 20:00:10 -04:00			`---------------------`
Finished /Contrib Index. Standardized READMEs. File and Link Fix. 2013-10-15 23:14:30 -04:00
contrib: Remove debian and rpm subfolders 2018-07-30 13:45:01 -04:00			`### Packaging ###`
			`The [Debian](/contrib/debian) subfolder contains the copyright file.`

			`All other packaging related files can be found in the [bitcoin-core/packaging](https://github.com/bitcoin-core/packaging) repository.`
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. 2013-10-12 10:45:25 -04:00
Finished /Contrib Index. Standardized READMEs. File and Link Fix. 2013-10-15 23:14:30 -04:00			`### [MacDeploy](/contrib/macdeploy) ###`
doc: Fix whitespace errs in .md files, bitcoin.conf, Info.plist.in, and find_bdb48.m4 2019-09-07 23:52:45 -04:00			`Scripts and notes for Mac builds.`
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. 2013-10-12 10:45:25 -04:00
doc: Fix whitespace errs in .md files, bitcoin.conf, Info.plist.in, and find_bdb48.m4 2019-09-07 23:52:45 -04:00			`Test and Verify Tools`
/contrib index reorg Cleaner and easier to read. Reordered by functionality 2014-04-12 02:46:55 -04:00			`---------------------`
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. 2013-10-12 10:45:25 -04:00
			`### [TestGen](/contrib/testgen) ###`
Finished /Contrib Index. Standardized READMEs. File and Link Fix. 2013-10-15 23:14:30 -04:00			`Utilities to generate test vectors for the data-driven Bitcoin tests.`

doc: Fix verify-binaries link in contrib README 2023-06-30 12:12:24 +02:00			`### [Verify-Binaries](/contrib/verify-binaries) ###`
[contrib] Remove reference to sf and add doc to verify.sh 2016-04-15 12:18:12 +02:00			`This script attempts to download and verify the signature file SHA256SUMS.asc from bitcoin.org.`
doc: Add completion subdir to contrib/README.md 2022-07-05 10:32:53 +01:00
			`Command Line Tools`
			`---------------------`

			`### [Completions](/contrib/completions) ###`
			`Shell completions for bash and fish.`
contrib: add tool to convert compact-serialized UTXO set to SQLite database 2023-04-06 18:31:49 +02:00
			`UTXO Set Tools`
			`--------------`

			`### [UTXO-to-SQLite](/contrib/utxo-tools/utxo_to_sqlite.py) ###`
			This script converts a compact-serialized UTXO set (as generated by Bitcoin Core with `dumptxoutset`)
			`to a SQLite3 database. For more details like e.g. the created table name and schema, refer to the`
			module docstring on top of the script, which is also contained in the command's `--help` output.