bitcoin/doc
steverusso 1e4eec47be doc: split FreeBSD build instructions out of build-unix.md
docs: Linked to the 'Building on FreeBSD' section of the Unix guide where it lists BSD specific guides.

Created a FreeBSD build guide (doc/build-freebsd.md).

Added in warning about the version of 'gdb' installed by default.

Removed the FreeBSD build instructions now that they have their own guide (doc/build-freebsd.md).

Updated the sentence to refer to the BSD guides in the 'doc' directory for more specific BSD build instructions.

Minor grammatical fix.
2018-06-02 01:42:50 -04:00
..
man
release-notes
.gitignore
Doxyfile.in
README.md
README_osx.md
README_windows.txt
REST-interface.md
assets-attribution.md
benchmarking.md
bips.md doc: Mention disabling BIP61 in bips.md 2018-05-13 21:03:27 +02:00
bitcoin_logo_doxygen.png
build-freebsd.md doc: split FreeBSD build instructions out of build-unix.md 2018-06-02 01:42:50 -04:00
build-netbsd.md
build-openbsd.md docs: Update OpenBSD build instructions for OpenBSD 6.3 2018-05-22 06:54:40 +02:00
build-osx.md doc: add qrencode to brew install instructions 2018-04-07 16:59:49 +02:00
build-unix.md doc: split FreeBSD build instructions out of build-unix.md 2018-06-02 01:42:50 -04:00
build-windows.md doc: Bump to Ubuntu Bionic 18.04 in build-windows.md 2018-05-17 11:12:18 +00:00
dependencies.md
developer-notes.md test: Move linters to test/lint, add readme 2018-05-24 12:02:15 -04:00
dnsseed-policy.md
files.md [doc] Include txindex changes in the release notes. 2018-04-25 11:25:19 -07:00
fuzzing.md
gitian-building.md
init.md
reduce-traffic.md
release-notes-pr10267.md doc: Add release notes for -includeconf 2018-05-02 14:26:46 +09:00
release-notes-pr10740.md [wallets] [docs] Add release notes for createwallet RPC. 2018-05-31 17:10:20 -04:00
release-notes-pr12823.md Add config changes to release notes 2018-04-11 23:15:28 +10:00
release-notes-pr12892.md [docs] Add release notes for deprecated 'account' API 2018-04-17 14:20:28 -04:00
release-notes-pr12924.md [docs] Add release notes for HD master key -> HD seed rename 2018-05-19 11:21:20 -04:00
release-notes-pr13033.md [doc] Include txindex changes in the release notes. 2018-04-25 11:25:19 -07:00
release-notes.md Merge #12729: Get rid of ambiguous OutputType::NONE value 2018-05-03 11:53:30 +02:00
release-process.md doc: update bitcoin-dot-org links in release-process.md 2018-05-30 20:11:36 +08:00
shared-libraries.md
tor.md Merge #12384: [Docs] Add version footnote to tor.md 2018-05-01 16:43:06 +02:00
translation_process.md
translation_strings_policy.md
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 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.