BTCP-Rebase/doc
Wladimir J. van der Laan c5f7efe331
Merge #12384: [Docs] Add version footnote to tor.md
39d2911 [Docs] Add version footnote to tor.md (Damian Williamson)

Pull request description:

  [Docs] Add version footnote to tor.md

  Added note to section 2, part -edits to `/etc/tor/torrc`- indicating this is only required for Tor version 0.2.7.0 and older, since section 3 states it is valid for Tor version 0.2.7.1 and newer. Added ref link from section 2 version footnote to section 3. Re-styled headings to work on GitHub -alternate heading style markup creation issue with numbered headings and thus headings and automatic heading links are broken-

  Ref: [Issue# 12376](https://github.com/bitcoin/bitcoin/issues/12376)

  Signed-off-by: Damian Williamson \<willtech@live.com.au\>

Tree-SHA512: 439f4ccc3e196011af448b220adf26b0e653ac589bf4cfbbc276c1500c9d08f209c9d6101e4d232857779d9f25164cfb222ed30e3d63de116f9121e6ebde31c3
2018-05-01 16:43:06 +02: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 Add NetBSD build instruction links 2018-01-30 21:03:58 +00:00
README_osx.md Fix typos and cleanup 2018-03-02 23:00:25 +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 List support for BIP173 in bips.md 2018-04-23 16:31:05 -07:00
bitcoin_logo_doxygen.png Lossless image optimization 2013-12-02 10:10:22 +01:00
build-netbsd.md [doc] Create build-netbsd.md 2018-01-30 07:47:27 +08:00
build-openbsd.md doc: Update OpenBSD build instructions for 6.2 2017-12-22 10:08:53 +01:00
build-osx.md doc: add qrencode to brew install instructions 2018-04-07 16:59:49 +02:00
build-unix.md doc: Mention configure without wallet in FreeBSD instructions 2018-03-06 22:07:20 +01:00
build-windows.md [doc] build-windows: Switch to Artful, since Zesty is EOL 2018-04-16 11:44:54 -04:00
dependencies.md Merge #12607: depends: Remove ccache 2018-03-07 21:12:47 -05:00
developer-notes.md Fix inconsistent namespace formatting guidelines 2018-04-13 15:37: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 docs: clarified systemd installation instructions in init.md for Ubuntu users. 2018-02-17 17:23:06 -07:00
reduce-traffic.md Remove maxuploadtargets recommended minimum 2016-09-13 18:08:17 +02: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-pr13033.md [doc] Include txindex changes in the release notes. 2018-04-25 11:25:19 -07:00
release-notes.md nit: descendent should be spelled descendant even in the release-notes 2018-04-30 19:21:18 +10:00
release-process.md Give hint about gitian not able to download 2018-03-06 17:14:29 -05: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 Fix typos and cleanup 2018-03-02 23:00:25 +02: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.

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.