mirrors/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2024-11-20 10:38:42 +01:00
Code Issues Projects Releases Wiki Activity
2209b3ba25
bitcoin/doc
History
MarcoFalke 2209b3ba25
Merge #15799: doc: Clarify RPC versioning 
fa747498f7 doc: Clarify RPC versioning (MarcoFalke)

Pull request description:

ACKs for commit fa7474:

Tree-SHA512: 4d374cc9ae77a06423acc9c73fe29f706f4349c548b17cb2414f15f72e0fc8c6ef7783ce099e938db2ab949717a4ef29e1aebc6aa09a350853d7f875b192ccb5
2019-04-15 11:20:53 -04:00
..
man util: Add SetupHelpOptions() 2019-02-06 14:16:43 -05:00
release-notes doc: Remove pr release notes file in wrong dir 2019-03-04 14:09:04 -05:00
.gitignore Ignore Doxyfile generated from Doxyfile.in template. 2017-04-07 16:28:12 +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 trivial: Fixed typos and cleaned up language 2018-08-02 21:27:16 +08:00
bips.md Update bips.md for 0.18.0 2019-04-06 08:37:07 -07:00
bitcoin_logo_doxygen.png
bitcoin-conf.md Add doc/bitcoin-conf.md 2018-10-19 01:13:57 +03:00
build-freebsd.md doc: update FreeBSD build guide for 12.0 2019-02-15 19:54:59 +08:00
build-netbsd.md doc: update NetBSD build instructions for 8.0 2018-12-13 12:05:45 +08:00
build-openbsd.md Merge #14515: doc: Update OpenBSD build guide for 6.4 2018-11-05 13:26:37 +01:00
build-osx.md doc: mention creating application support bitcoin folder on OSX 2019-04-12 09:18:41 -05:00
build-unix.md doc: Remove ppa from linux build instructions 2019-03-03 11:37:40 -05:00
build-windows.md doc: correct path in build-windows.md 2019-03-09 13:57:18 +08:00
dependencies.md doc: describe onlynet option in doc/tor.md 2019-04-11 14:05:02 +02:00
descriptors.md Mention new descriptor RPCs in descriptors.md 2019-04-06 08:17:51 -07:00
developer-notes.md [docs] remove reference to signrawtransaction in the developer docs. 2019-03-22 15:18:20 -04:00
dnsseed-policy.md Correct spelling mistakes in doc folder 2015-10-18 06:25:43 +10:00
Doxyfile.in doc: Make build system insert version in Doxyfile 2017-04-05 09:40:56 +02:00
files.md Add nice table to files.md 2018-12-11 22:24:09 +01:00
fuzzing.md qa: Add test/fuzz/test_runner.py 2019-02-13 17:12:28 -05:00
gitian-building.md doc: move gitian building to external repo 2017-09-25 15:45:38 +02:00
init.md init: Modify docs and add release note for 12255 2019-02-04 09:18:28 -05:00
JSON-RPC-interface.md doc: Clarify RPC versioning 2019-04-15 11:20:16 -04:00
productivity.md Merge #15603: docs: Add more tips to productivity.md 2019-03-25 18:26:41 -04:00
psbt.md Mention new PSBT RPCs in psbt.md 2019-04-05 09:06:44 -07:00
README_windows.txt doc: Remove version numbers from READMEs 2017-04-05 09:40:48 +02:00
README.md travis: Properly cache and error on timeout 2019-04-05 13:35:27 -04:00
reduce-traffic.md trivial: Fixed typos and cleaned up language 2018-08-02 21:27:16 +08:00
release-notes-14054.md [docs] release note for disabling reject messages by default 2019-03-15 09:16:12 -04:00
release-notes-15566.md cli: replace testnet with chain and return network name as per BIP70. 2019-03-09 16:35:26 +08:00
release-notes-15620.md doc: Add release notes for 15620 2019-03-19 17:06:43 -04:00
release-notes-15637.md rpc: Rename size to vsize in mempool related calls 2019-03-24 12:01:43 +08:00
release-notes.md Merge #15629: init: Throw error when network specific config is ignored 2019-04-09 21:14:49 -04:00
release-process.md doc: Update release process for snap package 2019-02-26 19:52:44 -05:00
REST-interface.md Address test todos by removing -txindex to nodes. 2019-02-17 21:42:08 -08:00
shared-libraries.md doc: correct bitcoinconsensus_version in shared-libraries 2019-04-07 21:42:32 +08:00
tor.md doc: describe onlynet option in doc/tor.md 2019-04-11 14:05:02 +02:00
translation_process.md docs: Update Transifex links 2019-03-02 17:42:33 +08:00
translation_strings_policy.md A few textual improvements 2019-02-08 09:47:50 +01:00
zmq.md ZMQ: add options to configure outbound message high water mark, aka SNDHWM 2018-10-19 07:36:13 -04: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. 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.