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
72506ed349
bitcoin/doc
History
Wladimir J. van der Laan 72506ed349
Merge #15177: rest: Improve tests and documention of /headers and /block 
7cf994d5cf qa: Improve tests of /rest/headers and /rest/block (João Barbosa)
0825b86b28 doc: /rest/block responds with 404 if block does not exist (João Barbosa)
be625f7c55 doc: Explain empty result of /rest/headers (João Barbosa)

Pull request description:

  Follow up of #15107.

Tree-SHA512: a7fdeed05216e3eda9604664db529237c2d0ddf422cfac139d6345a22b6e00bfe870d4e3f177423db7d4efb295ac2dc0ca2eb20c9c27c0719b89fd5428860d03
2019-01-21 17:37:55 +01:00
..
man Bump manpages 2018-12-29 10:26:00 +01:00
release-notes doc: Add historical release notes for 0.17.1 2018-12-25 10:18:10 +01:00
.gitignore
assets-attribution.md
benchmarking.md trivial: Fixed typos and cleaned up language 2018-08-02 21:27:16 +08:00
bips.md trivial: Fixed typos and cleaned up language 2018-08-02 21:27:16 +08:00
bitcoin_logo_doxygen.png
bitcoin-conf.md Add doc/bitcoin-conf.md 2018-10-19 01:13:57 +03:00
build-freebsd.md FreeBSD: Document Python 3 requirement for 'gmake check' 2018-10-31 02:52:50 -07: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] conf: Remove deprecated options from docs, Other cleanup 2018-11-07 13:30:03 -05:00
build-unix.md Various textual improvements in build docs 2018-10-28 06:01:01 +01:00
build-windows.md docs: add NSIS setup/install steps to windows docs 2018-12-13 22:52:17 +08:00
dependencies.md Update zmq to 4.3.1 2019-01-18 10:25:14 +02:00
descriptors.md A few minor formatting fixes and clarifications to descriptors.md 2018-11-22 00:21:29 -05:00
developer-notes.md Merge #14832: docs: Add more Doxygen information to Developer Notes 2019-01-04 11:49:29 +01:00
dnsseed-policy.md
Doxyfile.in
files.md Add nice table to files.md 2018-12-11 22:24:09 +01:00
fuzzing.md docs: Spelling error fix on fuzzing.md 2019-01-16 20:25:51 -06:00
gitian-building.md
init.md Fix typos 2018-10-04 21:58:24 +03:00
JSON-RPC-interface.md doc: Add external interface consistency guarantees 2018-10-30 16:40:36 -04:00
psbt.md Fix minor grammar error in doc 2018-12-20 21:59:56 +00:00
README_osx.md Rename “OS X” to the newer “macOS” convention 2018-06-04 13:04:04 +02:00
README_windows.txt
README.md Merge #15132: docs: Add FreeBSD build notes link to doc/README.md 2019-01-10 09:51:03 -05:00
reduce-traffic.md trivial: Fixed typos and cleaned up language 2018-08-02 21:27:16 +08:00
release-notes-14941.md doc: Add release notes for unloadwallet change to synchronous call 2019-01-15 00:01:00 +00:00
release-notes-14982.md doc: Add getrpcinfo release notes 2019-01-02 12:47:32 +00:00
release-notes.md Release notes: integrate detached release notes 2019-01-02 20:27:07 -05:00
release-process.md Merge #14433: Add checksum in gitian build scripts for ossl 2019-01-15 17:42:00 +01:00
REST-interface.md doc: /rest/block responds with 404 if block does not exist 2019-01-16 14:42:22 +00:00
shared-libraries.md
tor.md Less confusing documentation for torpassword 2018-11-26 08:45:32 +08:00
translation_process.md Docs: Improve "of" grammar 2018-08-03 02:49:48 +08:00
translation_strings_policy.md Docs: Modify policy to not translate command-line help 2018-07-04 09:18:29 +08:00
travis-ci.md
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.