BTCP-Rebase/doc
MarcoFalke b22115d9a3
Merge #13312: docs: Add a note about the source code filename naming convention
e56771365b Do not use uppercase characters in source code filenames (practicalswift)
419a1983ca docs: Add a note about the source code filename naming convention (practicalswift)

Pull request description:

  Add a note about the source code filename naming convention.

Tree-SHA512: 8d329bd9e19bcd26e74b0862fb0bc2369b46095dbd3e69d34859908632763abd7c3d00ccc44ee059772ad4bae4460c2bcc1c0e22fd9d8876d57e5fcd346cea4b
2018-06-12 08:02:20 -04:00
..
man doc: Update manpages to 0.16.99 2018-01-30 14:24:59 +01:00
release-notes doc: Add historical release notes for 0.16.0 2018-02-26 12:25:01 +01:00
.gitignore Ignore Doxyfile generated from Doxyfile.in template. 2017-04-07 16:28:12 +02:00
Doxyfile.in doc: Make build system insert version in Doxyfile 2017-04-05 09:40:56 +02:00
README.md Rename “OS X” to the newer “macOS” convention 2018-06-04 13:04:04 +02:00
README_osx.md Rename “OS X” to the newer “macOS” convention 2018-06-04 13:04:04 +02:00
README_windows.txt doc: Remove version numbers from READMEs 2017-04-05 09:40:48 +02:00
REST-interface.md Fix typos and cleanup 2018-03-02 23:00:25 +02:00
assets-attribution.md [doc] Merge doc/assets-attribution.md into contrib/debian/copyright 2015-09-18 18:14:42 +02:00
benchmarking.md Updating benchmarkmarking.md with an updated sample output and help options 2018-01-19 11:41:56 -06:00
bips.md doc: Mention disabling BIP61 in bips.md 2018-05-13 21:03:27 +02:00
bitcoin_logo_doxygen.png Lossless image optimization 2013-12-02 10:10:22 +01:00
build-freebsd.md doc: split FreeBSD build instructions out of build-unix.md 2018-06-02 01:42:50 -04:00
build-netbsd.md [doc] Create build-netbsd.md 2018-01-30 07:47:27 +08:00
build-openbsd.md docs: Update OpenBSD build instructions for OpenBSD 6.3 2018-05-22 06:54:40 +02:00
build-osx.md Rename “OS X” to the newer “macOS” convention 2018-06-04 13:04:04 +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 Merge #12607: depends: Remove ccache 2018-03-07 21:12:47 -05:00
developer-notes.md Merge #13312: docs: Add a note about the source code filename naming convention 2018-06-12 08:02:20 -04:00
dnsseed-policy.md Correct spelling mistakes in doc folder 2015-10-18 06:25:43 +10:00
files.md [doc] Include txindex changes in the release notes. 2018-04-25 11:25:19 -07:00
fuzzing.md [test] Speed up fuzzing by ~200x when using afl-fuzz 2017-05-19 07:28:46 +02:00
gitian-building.md doc: move gitian building to external repo 2017-09-25 15:45:38 +02:00
init.md Rename “OS X” to the newer “macOS” convention 2018-06-04 13:04:04 +02:00
reduce-traffic.md Remove maxuploadtargets recommended minimum 2016-09-13 18:08:17 +02:00
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 [wallet] [docs] Update release notes for removing `getlabeladdress` 2018-05-16 17:45:19 -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 [qt] OptionsDialog: add prune setting 2018-05-15 12:46:19 +02:00
release-process.md Rename “OS X” to the newer “macOS” convention 2018-06-04 13:04:04 +02:00
shared-libraries.md Add NULLDUMMY verify flag in bitcoinconsensus.h 2016-09-30 23:09:19 +08:00
tor.md Merge #12384: [Docs] Add version footnote to tor.md 2018-05-01 16:43:06 +02:00
translation_process.md [docs] update transifex doc link 2018-06-02 12:26:21 +03:00
translation_strings_policy.md Init: Cleanup error and warning strings 2015-10-28 22:11:43 +01:00
travis-ci.md [doc] Rework docs 2016-10-04 13:27:38 +02:00
zmq.md Fix typos and cleanup 2018-03-02 23:00:25 +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 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.

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