mirror of https://github.com/bitcoin/bitcoin.git synced 2026-01-20 07:09:15 +01:00

Files

MarcoFalke 16521ce086 Merge #14945 : [0.17] Backport: PSBT documentation

fa0c76adee Fix minor grammar error in doc (bitcoinhodler)
88c566a13f doc: Fix PSBT howto and example parameters (priscoan)
ddd008dbef Add PSBT documentation (Pieter Wuille)

Pull request description:

  Backports #13941, #14319 and #15012 to 0.17.

Tree-SHA512: 9fbc900aa98f948260273970c4e51e69088460e153fd7dae8f3ddebf37c68ecdf1cd02f1f32759c638e5aecbb89529631e8cc7cad0e6370dbc21e70baa6e9145

2018-12-30 18:38:48 +01:00

man

build: bump version to 0.17.1

2018-12-06 11:41:25 +01:00

release-notes

doc: Add historical release notes for 0.16.2

2018-07-29 19:02:26 +02:00

.gitignore

Ignore Doxyfile generated from Doxyfile.in template.

2017-04-07 16:28:12 +02:00

assets-attribution.md

[doc] Merge doc/assets-attribution.md into contrib/debian/copyright

2015-09-18 18:14:42 +02:00

benchmarking.md

trivial: Fixed typos and cleaned up language

2018-08-02 21:27:16 +08:00

bips.md

trivial: Fixed typos and cleaned up language

2018-08-02 21:27:16 +08:00

bitcoin_logo_doxygen.png

Lossless image optimization

2013-12-02 10:10:22 +01:00

build-freebsd.md

Fix incorrect shell quoting in FreeBSD build instructions.

2018-06-15 01:34:40 -07:00

build-netbsd.md

doc: update NetBSD build instructions for 8.0

2018-12-29 17:31:34 +08:00

build-openbsd.md

docs: Update OpenBSD build instructions for OpenBSD 6.3

2018-05-22 06:54:40 +02:00

build-osx.md

trivial: Fixed typos and cleaned up language

2018-08-02 21:27:16 +08:00

build-unix.md

Add autogen.sh in ARM Cross-compilation

2018-11-28 15:35:05 -05:00

build-windows.md

trivial: Fixed typos and cleaned up language

2018-08-02 21:27:16 +08:00

dependencies.md

doc: correct versions in dependencies.md

2018-08-03 09:06:36 +08:00

descriptors.md

descriptors.md: Refer to descriptors as describing instead of matching

2018-10-24 22:03:08 -04:00

developer-notes.md

Merge #13717 : docs: Link to python style guidelines from developer notes

2018-08-07 13:56:31 +02:00

dnsseed-policy.md

Correct spelling mistakes in doc folder

2015-10-18 06:25:43 +10:00

Doxyfile.in

doc: Make build system insert version in Doxyfile

2017-04-05 09:40:56 +02:00

files.md

[doc] Include txindex changes in the release notes.

2018-04-25 11:25:19 -07:00

fuzzing.md

[test] Speed up fuzzing by ~200x when using afl-fuzz

2017-05-19 07:28:46 +02:00

gitian-building.md

doc: move gitian building to external repo

2017-09-25 15:45:38 +02:00

init.md

contrib: Remove debian and rpm subfolders

2018-07-30 14:00:56 -04:00

psbt.md

Fix minor grammar error in doc

2018-12-28 18:58:38 +08:00

README_osx.md

Rename “OS X” to the newer “macOS” convention

2018-06-04 13:04:04 +02:00

README_windows.txt

doc: Remove version numbers from READMEs

2017-04-05 09:40:48 +02:00

README.md

Add PSBT documentation

2018-12-28 18:58:38 +08:00

reduce-traffic.md

trivial: Fixed typos and cleaned up language

2018-08-02 21:27:16 +08:00

release-notes.md

doc: Clean out release notes post-0.17.1

2018-12-25 10:21:54 +01:00

release-process.md

doc: Improve command to generate list of authors for release notes

2018-07-19 16:03:00 +10:00

REST-interface.md

Fix typos and cleanup

2018-03-02 23:00:25 +02:00

shared-libraries.md

Add NULLDUMMY verify flag in bitcoinconsensus.h

2016-09-30 23:09:19 +08:00

tor.md

trivial: Fixed typos and cleaned up language

2018-08-02 21:27:16 +08:00

translation_process.md

Docs: Improve "of" grammar

2018-08-03 02:49:48 +08:00

translation_strings_policy.md

Docs: Modify policy to not translate command-line help

2018-07-04 09:18:29 +08:00

travis-ci.md

[doc] Rework docs

2016-10-04 13:27:38 +02:00

zmq.md

Fix typos and cleanup

2018-03-02 23:00:25 +02:00

README.md

Bitcoin Core

Setup

Bitcoin Core is the original Bitcoin client and it builds the backbone of the network. It downloads and, by default, stores the entire history of Bitcoin transactions (which is currently more than 100 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.

To download Bitcoin Core, visit bitcoincore.org.

Running

The following are some helpful notes on how to run Bitcoin Core on your native platform.

Unix

Unpack the files into a directory and run:

bin/bitcoin-qt (GUI) or
bin/bitcoind (headless)

Windows

Unpack the files into a directory, and then run bitcoin-qt.exe.

macOS

Drag Bitcoin Core to your applications folder, and then run Bitcoin Core.

Need Help?

See the documentation at the Bitcoin Wiki for help and more information.
Ask for help on #bitcoin on Freenode. If you don't have an IRC client use webchat here.
Ask for help on the BitcoinTalk forums, in the Technical Support board.

Building

The following are developer notes on how to build Bitcoin Core on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc.

Development

The Bitcoin repo's root README contains relevant information on the development process and automated testing.

Resources

Discuss on the BitcoinTalk forums, in the Development & Technical Discussion board.
Discuss project-specific development on #bitcoin-core-dev on Freenode. If you don't have an IRC client use webchat here.
Discuss general Bitcoin development on #bitcoin-dev on Freenode. If you don't have an IRC client use webchat here.

Miscellaneous

License

Distributed under the MIT software license. This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. This product includes cryptographic software written by Eric Young (eay@cryptsoft.com), and UPnP software written by Thomas Bernard.