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
Russell Yanofsky 434f5a2506
Recommend #include<> syntax in developer notes
7 years ago
..
man doc: Bump manpages to 0.15.99 7 years ago
release-notes doc: Add historical release notes for 0.15.1 7 years ago
.gitignore
Doxyfile.in
README.md Create dependencies.md, and link dependencies file from README & build docs 7 years ago
README_osx.md
README_windows.txt
REST-interface.md Merge #10825: net: set regtest JSON-RPC port to 18443 to avoid conflict with testnet 18332 7 years ago
assets-attribution.md
benchmarking.md
bips.md
bitcoin_logo_doxygen.png
build-openbsd.md [Docs] Update OpenBSD Build Instructions for OpenBSD 6.2 7 years ago
build-osx.md Merge #10779: Create dependencies.md 7 years ago
build-unix.md Merge #10779: Create dependencies.md 7 years ago
build-windows.md trivial: Fix typo – "Ubutntu" → "Ubuntu" 7 years ago
dependencies.md [Docs] Fix broken Markdown table in dependencies.md. Cleanups. 7 years ago
developer-notes.md Recommend #include<> syntax in developer notes 7 years ago
dnsseed-policy.md
files.md qt: Backup former GUI settings on `-resetguisettings` 7 years ago
fuzzing.md
gitian-building.md doc: move gitian building to external repo 7 years ago
init.md Update init.md: Fix section numbering. 7 years ago
reduce-traffic.md
release-notes.md doc: Add getreceivedbyaddress release notes 7 years ago
release-process.md Add instructions for multi-processor gitian builds 7 years ago
shared-libraries.md
tor.md
translation_process.md
translation_strings_policy.md
travis-ci.md
zmq.md Docs: Hash in ZMQ hash is raw bytes, not hex 7 years ago

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 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.

OS X

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 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.