bitcoin/doc
Wladimir J. van der Laan 2584929823
doc: Add steps for transifex to release process
Document how to update settings on and for the transifex website before
and after branch-off of a new release.
2021-07-03 21:31:26 +02:00
..
man scripted-diff: Fix typo in stub manual pages 2021-01-12 16:46:55 +01:00
release-notes doc: Add doc/release-notes/release-notes-0.21.1.md 2021-05-02 09:59:14 +02:00
.gitignore Ignore Doxyfile generated from Doxyfile.in template. 2017-04-07 16:28:12 +02:00
Doxyfile.in configure: add --enable-external-signer 2021-02-21 16:27:10 +01:00
JSON-RPC-interface.md Update 'Secure string handling' 2020-12-29 01:49:30 +05:30
README.md doc: doc/README.md IRC updates 2021-06-27 21:26:03 +02:00
README_doxygen.md doc: Improve doxygen readme navigation section 2019-09-23 19:22:06 -04:00
README_windows.txt doc: Remove version numbers from READMEs 2017-04-05 09:40:48 +02:00
REST-interface.md rpc: deprecate `addresses` and `reqSigs` from rpc outputs 2021-03-23 10:51:43 -04:00
assets-attribution.md [doc] Merge doc/assets-attribution.md into contrib/debian/copyright 2015-09-18 18:14:42 +02:00
benchmarking.md Replace current benchmarking framework with nanobench 2020-06-13 12:24:18 +02:00
bips.md doc: Update bips.md for 0.21.1 2021-05-12 10:06:37 +02:00
bitcoin-conf.md doc: add signet to doc/bitcoin-conf.md 2021-03-08 00:44:54 +01:00
bitcoin_logo_doxygen.png Lossless image optimization 2013-12-02 10:10:22 +01:00
build-android.md Qt: add Android packaging support 2021-03-21 22:33:27 +01:00
build-freebsd.md docs: improve make with parallel jobs description. 2021-05-14 08:45:27 +08:00
build-netbsd.md docs: improve make with parallel jobs description. 2021-05-14 08:45:27 +08:00
build-openbsd.md docs: improve make with parallel jobs description. 2021-05-14 08:45:27 +08:00
build-osx.md doc: note that brew installed qt is not supported 2021-05-17 21:36:08 -04:00
build-unix.md docs: improve make with parallel jobs description. 2021-05-14 08:45:27 +08:00
build-windows.md doc: improve note on choosing posix mingw32 2021-05-27 19:00:34 -04:00
dependencies.md doc: Document minimum required libc++ version 2021-06-28 05:10:56 +03:00
descriptors.md Add tr() descriptor (derivation only, no signing) 2021-05-24 12:14:16 -07:00
developer-notes.md doc: remove obsolete `okSafeMode` RPC guideline from developer notes 2021-06-10 02:02:29 +02:00
dnsseed-policy.md Correct spelling mistakes in doc folder 2015-10-18 06:25:43 +10:00
external-signer.md Move external signer out of wallet module 2021-04-08 17:56:00 +02:00
files.md doc: fix grammar in doc/files.md 2021-06-21 15:27:57 +02:00
fuzzing.md doc: describe in fuzzing.md how to reproduce a CI crash 2021-05-25 15:18:50 +02:00
gitian-building.md doc: move gitian building to external repo 2017-09-25 15:45:38 +02:00
guix.md docs: Point to contrib/guix/README.md in doc/guix.md 2021-01-08 11:40:01 -05:00
i2p.md doc: add basic I2P documentation 2021-06-23 12:21:38 +02:00
init.md doc: Replace tabs for spaces 2021-02-04 12:06:13 +00:00
multiprocess.md multiprocess: Add comments and documentation 2021-04-23 03:02:50 -05:00
productivity.md doc: Add libnatpmp stuff 2021-01-07 18:07:10 +02:00
psbt.md doc: fix/improve analyzepsbt in doc/psbt.md 2019-05-19 17:31:37 +02:00
reduce-memory.md doc: update reduce-memory.md peer connections info 2021-04-17 20:17:59 +02:00
reduce-traffic.md doc: Use precise permission flags where possible 2020-07-10 15:37:42 +02:00
release-notes.md doc: Final merge of release notes snippets 2021-06-21 16:31:06 +02:00
release-process.md doc: Add steps for transifex to release process 2021-07-03 21:31:26 +02:00
shared-libraries.md doc: libbitcoinconsensus: add missing error code description, fix NBitcoin link 2020-12-05 13:37:00 +01:00
tor.md doc: update tor.md with removal of tor v2 support 2021-06-06 19:05:01 +02:00
translation_process.md doc: Fix external links (IRC, ...) 2021-05-31 17:27:57 +02:00
translation_strings_policy.md doc: Do not translate technical or extremely rare errors 2020-05-05 04:46:08 +03:00
zmq.md doc: Adjust ZMQ usage to support multiple interfaces 2020-09-23 23:14:28 +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 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.