You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
bitcoin/doc
MarcoFalke a74d588f21
Merge #14954: build: Require python 3.5
6 years ago
..
man util: Add SetupHelpOptions() 6 years ago
release-notes doc: Remove pr release notes file in wrong dir 6 years ago
.gitignore
Doxyfile.in
JSON-RPC-interface.md Doc: add information about security to the JSON-RPC doc 6 years ago
README.md doc: Add separate productivity notes document 6 years ago
README_windows.txt
REST-interface.md Address test todos by removing -txindex to nodes. 6 years ago
assets-attribution.md
benchmarking.md
bips.md
bitcoin-conf.md
bitcoin_logo_doxygen.png
build-freebsd.md doc: update FreeBSD build guide for 12.0 6 years ago
build-netbsd.md doc: update NetBSD build instructions for 8.0 6 years ago
build-openbsd.md Merge #14515: doc: Update OpenBSD build guide for 6.4 6 years ago
build-osx.md Delete README_osx.md and move its contents into build-osx.md 6 years ago
build-unix.md doc: Remove ppa from linux build instructions 6 years ago
build-windows.md docs: add NSIS setup/install steps to windows docs 6 years ago
dependencies.md build: Require python 3.5 6 years ago
descriptors.md Add checksums to descriptors.md 6 years ago
developer-notes.md docs: Update Transifex links 6 years ago
dnsseed-policy.md
files.md Add nice table to files.md 6 years ago
fuzzing.md qa: Add test/fuzz/test_runner.py 6 years ago
gitian-building.md
init.md init: Modify docs and add release note for 12255 6 years ago
productivity.md doc: Add separate productivity notes document 6 years ago
psbt.md Fix minor grammar error in doc 6 years ago
reduce-traffic.md
release-notes-14021.md Add release notes for importing key origin info change 6 years ago
release-notes-14481.md Add release note for listunspent P2WSH change 6 years ago
release-notes-14491.md Add release notes for importmulti descriptor support 6 years ago
release-notes-14667.md [rpc] util: add deriveaddresses method 6 years ago
release-notes-15226.md [wallet] Support creating a blank wallet 6 years ago
release-notes-15393.md Bump minimum Qt version to 5.5.1 6 years ago
release-notes-15492.md [rpc] remove deprecated generate method 6 years ago
release-notes.md Merge #15514: docs: Update Transifex links 6 years ago
release-process.md doc: Update release process for snap package 6 years ago
shared-libraries.md
tor.md Less confusing documentation for `torpassword` 6 years ago
translation_process.md docs: Update Transifex links 6 years ago
translation_strings_policy.md A few textual improvements 6 years ago
travis-ci.md
zmq.md

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 requires a few hundred gigabytes of disk space. 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?

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

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.