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
88445889f1
bitcoin/doc
History
Wladimir J. van der Laan 8f1753b298
Merge #14804: docs: Less confusing documentation for torpassword 
6c6ee8af8 Less confusing documentation for `torpassword` (Chakib Benziane)

Pull request description:

  Rebased & squashed #14609.

  > The current documentation leads the reader to think hash-password is an other option.
  This change is less confusing and make it clear how to use this option.

Tree-SHA512: b94223715f1d28a8218e501117faa103d7cc791333e6d9a40e9253756070316d41de73e3b4593cd1fa9e1823fa8e8de4938cf0de89117a6e4649401d877e3477
2018-12-04 11:30:30 +01:00
..
man configure: Make it possible to build only one of bitcoin-cli or bitcoin-tx 2018-09-13 11:48:23 +00:00
release-notes doc: Add historical release notes for 0.17.0.1 2018-11-06 09:23:50 +01:00
.gitignore Ignore Doxyfile generated from Doxyfile.in template. 2017-04-07 16:28:12 +02:00
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] Create build-netbsd.md 2018-01-30 07:47:27 +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 Various textual improvements in build docs 2018-10-28 06:01:01 +01:00
dependencies.md [depends, zmq, doc] upgrade zeromq to 4.2.5 and avoid deprecated zeromq api functions 2018-09-11 16:33:05 -04:00
descriptors.md A few minor formatting fixes and clarifications to descriptors.md 2018-11-22 00:21:29 -05:00
developer-notes.md Improve scripted-diff developer docs 2018-11-15 15:45:48 -08:00
dnsseed-policy.md
Doxyfile.in doc: Make build system insert version in Doxyfile 2017-04-05 09:40:56 +02: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 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 Add PSBT documentation 2018-08-14 12:13:42 -07: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
README.md doc: Add external interface consistency guarantees 2018-10-30 16:40:36 -04:00
reduce-traffic.md trivial: Fixed typos and cleaned up language 2018-08-02 21:27:16 +08:00
release-notes-14060.md doc: add detached release notes for #14060 2018-11-10 10:25:27 -05:00
release-notes-14477.md Add release notes 2018-11-14 14:21:42 -08:00
release-notes-pr13381.md rpc: creates possibility to preserve labels on importprivkey 2018-10-05 13:33:21 +01:00
release-notes.md Release notes: integrate detached release notes 2018-11-11 07:03:51 -05:00
release-process.md Update release-process.md to include RC version bumping 2018-11-01 11:32:18 -04:00
REST-interface.md doc: Add external interface consistency guarantees 2018-10-30 16:40:36 -04: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.