dogecoin/doc
MarcoFalke 3b5b276734
Merge #17942: doc: Improve fuzzing docs for macOS users
b6c3e84e87 doc: Improve fuzzing docs for macOS users (Fabian Jahr)

Pull request description:

  Adds several helpful hints for macOS users trying to get fuzzers to run locally using AFL or libFuzzer. These are partly based on this comment https://github.com/bitcoin/bitcoin/issues/17657#issuecomment-562869600 and discussions in the review club for #17860. See: https://bitcoincore.reviews/17860.html

  Based on the doc in the current state I could not compile fuzzers for AFL or libFuzzer. Using these hints, I can
  - compile and run fuzzers with AFL
  - compile but **not** run fuzzers with libFuzzer

  Fuzzers compiled with libFuzzers may be running but don't produce any output. Looking for others to test this to see if it is an issue with my local system. Especially interesting if you have been running libFuzzer fuzzers successfully on macOS before.

  Edit: Closes #17914

ACKs for top commit:
  MarcoFalke:
    ACK b6c3e84e87
  Sjors:
    ACK b6c3e84
  fanquake:
    ACK b6c3e84e87 - I think this has been nitpicked enough, and importantly the commands look better now.

Tree-SHA512: fdbacbcf10e9353a4ac3d22edf88663e33185ad2f244b986ff74c513de05f9fa62c4d8b17985d2f9288834c124b352cf52280627b5ff095735b411b12482e2ec
2020-01-29 08:45:09 -05:00
..
man doc: remove OpenSSL from build instructions and licensing info 2019-11-18 08:56:48 -05:00
release-notes doc: Add historical release notes for 0.19.0.1 2019-11-24 11:15:03 +01: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 [doc] fix Makefile target in benchmarking.md 2019-10-08 22:14:04 +02:00
bips.md doc: Update doc/bips.md with recent changes in master 2019-11-05 10:20:16 -05:00
bitcoin-conf.md doc: add default bitcoin.conf locations 2019-08-19 19:34:57 +02:00
bitcoin_logo_doxygen.png Lossless image optimization 2013-12-02 10:10:22 +01:00
build-freebsd.md doc: remove OpenSSL from build instructions and licensing info 2019-11-18 08:56:48 -05: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 build: set minimum supported macOS to 10.12 2019-11-21 11:08:47 -05:00
build-unix.md doc: Remove ssl as a required dependency from build-unix 2019-11-19 15:03:44 +01:00
build-windows.md doc: compiling with Visual Studio is now supported on Windows 2019-11-01 15:25:52 -04:00
dependencies.md doc: Update dependencies.md 2019-12-29 13:07:50 +02:00
descriptors.md Update descriptors.md to include sortedmulti 2019-10-08 13:56:56 -04:00
developer-notes.md Merge #17819: doc: developer notes guideline on RPCExamples addresses 2020-01-16 15:23:40 -05:00
dnsseed-policy.md Correct spelling mistakes in doc folder 2015-10-18 06:25:43 +10:00
Doxyfile.in doc: Move doxygen intro to file for USE_MDFILE_AS_MANPAGE 2019-09-23 19:22:06 -04:00
files.md doc: Add missing indexes/blockfilter/basic/ to doc/files.md 2019-10-11 08:31:18 -04:00
fuzzing.md doc: Improve fuzzing docs for macOS users 2020-01-29 00:46:21 +01:00
gitian-building.md doc: move gitian building to external repo 2017-09-25 15:45:38 +02:00
init.md doc: Fix whitespace errs in .md files, bitcoin.conf, Info.plist.in, and find_bdb48.m4 2019-09-17 03:21:22 -04:00
JSON-RPC-interface.md doc: Clarify RPC versioning 2019-04-15 11:20:16 -04:00
productivity.md docs: Add productivity notes for "dummy rebases" 2019-05-15 14:12:45 -04:00
psbt.md doc: fix/improve analyzepsbt in doc/psbt.md 2019-05-19 17:31:37 +02:00
rapidcheck.md doc: initial RapidCheck property-based testing documentation 2019-08-19 09:18:16 +02:00
README.md doc: Change doxygen URL to doxygen.bitcoincore.org 2019-11-25 19:20:49 +01:00
README_doxygen.md doc: Improve doxygen readme navigation section 2019-09-23 19:22:06 -04:00
README_windows.txt doc: Remove version numbers from READMEs 2017-04-05 09:40:48 +02:00
reduce-memory.md use preferred shebang approach for documentation 2019-12-17 12:18:13 -05:00
reduce-traffic.md doc: Mention blocksonly in reduce-traffic.md, unhide option 2019-05-13 10:44:46 -04:00
release-notes-15437.md [docs] Add release notes for removal of REJECT reasons 2019-10-10 13:31:57 -04:00
release-notes-15954.md remove old bootstrap relevant code 2019-11-05 16:47:26 +01:00
release-notes-17056.md Add release note 2019-10-08 13:56:56 -04:00
release-notes-17410.md doc: Add relase note for db→walletdb rename 2019-11-08 23:05:47 +01:00
release-notes-17437.md rpc: Expose block height of wallet transactions 2019-11-11 22:32:44 +00:00
release-notes-17578.md doc: update release notes 2020-01-03 19:51:11 +01:00
release-notes.md doc: Add release note for RPC Whitelist 2019-12-15 20:49:49 +01:00
release-process.md Merge #17598: doc: Update release process with latest changes 2019-12-12 07:06:21 -05:00
REST-interface.md doc: Remove explicit network name references 2019-11-01 12:06:35 +01:00
shared-libraries.md doc: correct bitcoinconsensus_version in shared-libraries 2019-04-07 21:42:32 +08:00
tor.md Elaborate on the need to re-login on Debian-based systems to use tor following usermod 2019-09-12 08:27:03 -05:00
translation_process.md build: Factor out qt translations from build system 2019-09-29 14:24:54 +02:00
translation_strings_policy.md A few textual improvements 2019-02-08 09:47:50 +01:00
zmq.md doc: Add note regarding ZMQ block notification 2019-08-19 01:05:58 +01:00

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.