mirror of https://github.com/bitcoin/bitcoin.git synced 2025-05-03 00:10:52 +02:00

History

Merge #14832 : docs: Add more Doxygen information to Developer Notes

a62e667296 docs: Add more Doxygen information to Developer Notes (Jon Layton)

Pull request description:

  Update information about Doxygen in `doc/developer-notes.md`.

  Alternatively, this could have its own file (like `doc/web-documentation.md`), since there are installation steps included.

  For example, I had to run:
  ```
  brew install doxygen graphviz
  ```
  on MacOS, otherwise failures occurred.

  This information could also be linked to the `doc/release-process.md`.

Tree-SHA512: 5d77ee83e1b96fde036482b502f676a90a56f3f667753545a7cfba5c2e3b825644bb4cf0f8a84b7f9ba92fa5f2e1cd6ef1e27a94277f43d012355df741f7dd2f

2019-01-04 11:49:29 +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

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: 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

depends: qt 5.9.7

2018-12-12 20:59:30 +08: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

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

[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

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

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.md

Release notes: integrate detached release notes

2019-01-02 20:27:07 -05:00

release-process.md

http -> https

2018-11-24 20:09:56 +02: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

[doc] Rework docs

2016-10-04 13:27:38 +02: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?

See the documentation at the Bitcoin Wiki for help and more information.
Ask for help on #bitcoin on Freenode. If you don't have an IRC client, use webchat here.
Ask for help on the BitcoinTalk forums, in the Technical Support board.

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

Discuss on the BitcoinTalk forums, in the Development & Technical Discussion board.
Discuss project-specific development on #bitcoin-core-dev on Freenode. If you don't have an IRC client, use webchat here.
Discuss general Bitcoin development on #bitcoin-dev on Freenode. If you don't have an IRC client, use webchat here.

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.