0
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-03-06 14:19:59 -05:00
bitcoin-core/doc
merge-script 39219fe145
Merge bitcoin/bitcoin#30946: doc: correct the zmq automatic build info
06e7e83632 doc: correct the zmq automatic build info (tdb3)

Pull request description:

  The current documentation states that the ZMQ feature is automatically included when building.
  Noticed this was no longer the case when building to review PR #30942.

ACKs for top commit:
  l0rinc:
    ACK 06e7e83632
  hebasto:
    re-ACK 06e7e83632.

Tree-SHA512: 24269c29415e54815b105e3f830f31f055e9bdcb3bf4a7cede068651875190adfc4e72ad5448b3c30a23b0db024f743d9f18576a6fda46d87deb5ea39352e626
2024-09-25 12:21:51 +01:00
..
design doc: Updating docs from autotools to cmake 2024-09-18 11:04:52 -04:00
man build: Remove Autotools-based build system 2024-08-30 21:31:39 +01:00
policy
release-notes docs: Remove release 28.0 release notes fragments 2024-08-27 11:14:25 -04:00
assets-attribution.md
assumeutxo.md doc: fix assumeutxo design doc link 2024-09-04 22:53:34 +01:00
benchmarking.md doc: Update for CMake-based build system 2024-08-16 21:24:08 +01:00
bips.md docs: Add 379 and 387 to bips.md 2024-08-27 11:20:54 -04:00
bitcoin-conf.md
bitcoin_logo_doxygen.png
build-freebsd.md doc: add with_bdb to unix build docs 2024-08-31 16:53:59 -04:00
build-netbsd.md doc: Update for CMake-based build system 2024-08-16 21:24:08 +01:00
build-openbsd.md doc: remove extraneous install statement 2024-08-31 17:54:39 -04:00
build-osx.md doc: fix compiler flags for macOS configuration 2024-09-02 12:53:50 +01:00
build-unix.md Merge bitcoin/bitcoin#30779: doc: add -DWITH_BDB=ON to unix build docs 2024-09-02 15:04:23 +01:00
build-windows-msvc.md docs: Fix minor typo 2024-09-08 20:25:53 +02:00
build-windows.md doc: Drop ctest command from Windows cross-compiling instructions 2024-09-06 21:59:52 +01:00
cjdns.md
CMakeLists.txt cmake: add USE_SOURCE_PERMISSIONS to all configure_file usage 2024-09-06 10:52:19 +01:00
dependencies.md doc: replace Autotools with CMake 2024-08-29 16:06:29 +01:00
descriptors.md Merge bitcoin/bitcoin#22838: descriptors: Be able to specify change and receiving in a single descriptor string 2024-08-28 15:56:15 +01:00
developer-notes.md doc: Updating docs from autotools to cmake 2024-09-18 11:04:52 -04:00
dnsseed-policy.md
Doxyfile.in
external-signer.md
files.md
fuzzing.md doc: Adjust links in OSS-Fuzz section 2024-09-24 22:09:17 +02:00
guix.md
i2p.md
init.md
JSON-RPC-interface.md
managing-wallets.md
multiprocess.md doc: Updating docs from autotools to cmake 2024-09-18 11:04:52 -04:00
multisig-tutorial.md doc: Prepend 'build/' to binary paths under 'src/' in docs 2024-08-29 15:23:12 +02:00
offline-signing-tutorial.md doc: Prepend 'build/' to binary paths under 'src/' in docs 2024-08-29 15:23:12 +02:00
p2p-bad-ports.md
productivity.md doc: Update for CMake-based build system 2024-08-16 21:24:08 +01:00
psbt.md
README.md doc: Update for CMake-based build system 2024-08-16 21:24:08 +01:00
README_doxygen.md
README_windows.txt
reduce-memory.md
reduce-traffic.md
release-notes-28358.md
release-notes-empty-template.md
release-process.md doc: Update for CMake-based build system 2024-08-16 21:24:08 +01:00
REST-interface.md
tor.md
tracing.md doc: Prepend 'build/' to binary paths under 'src/' in docs 2024-08-29 15:23:12 +02:00
translation_process.md doc: Updating docs from autotools to cmake 2024-09-18 11:04:52 -04:00
translation_strings_policy.md doc: Updating docs from autotools to cmake 2024-09-18 11:04:52 -04:00
zmq.md doc: correct the zmq automatic build info 2024-09-25 07:07:04 -04:00

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.