|
Name |
|
Date |
Size |
#Lines |
LOC |
| .. | | 08-Sep-2021 | - |
| man/ | H | 08-Sep-2021 | - | 2,041 | 2,022 |
| release-notes/ | H | 08-Sep-2021 | - | 17,944 | 15,060 |
| .gitignore | H A D | 08-Sep-2021 | 9 | 2 | 1 |
| Doxyfile.in | H A D | 08-Sep-2021 | 104.8 KiB | 2,462 | 1,913 |
| JSON-RPC-interface.md | H A D | 08-Sep-2021 | 7.5 KiB | 142 | 118 |
| README.md | H A D | 08-Sep-2021 | 3.5 KiB | 89 | 69 |
| README_doxygen.md | H A D | 08-Sep-2021 | 874 | 16 | 9 |
| REST-interface.md | H A D | 08-Sep-2021 | 4.7 KiB | 121 | 92 |
| assets-attribution.md | H A D | 08-Sep-2021 | 145 | 2 | 1 |
| benchmarking.md | H A D | 08-Sep-2021 | 2 KiB | 62 | 44 |
| bips.md | H A D | 08-Sep-2021 | 13.5 KiB | 60 | 58 |
| bitcoin-conf.md | H A D | 08-Sep-2021 | 2.8 KiB | 65 | 41 |
| build-android.md | H A D | 08-Sep-2021 | 431 | 12 | 7 |
| build-freebsd.md | H A D | 08-Sep-2021 | 6 KiB | 130 | 98 |
| build-netbsd.md | H A D | 08-Sep-2021 | 1.9 KiB | 82 | 63 |
| build-openbsd.md | H A D | 08-Sep-2021 | 3.9 KiB | 124 | 91 |
| build-osx.md | H A D | 08-Sep-2021 | 10.8 KiB | 331 | 224 |
| build-unix.md | H A D | 08-Sep-2021 | 11.9 KiB | 339 | 221 |
| build-windows.md | H A D | 08-Sep-2021 | 7.1 KiB | 155 | 110 |
| dependencies.md | H A D | 08-Sep-2021 | 3.6 KiB | 49 | 42 |
| descriptors.md | H A D | 08-Sep-2021 | 15.6 KiB | 221 | 182 |
| developer-notes.md | H A D | 08-Sep-2021 | 52.9 KiB | 1,336 | 1,004 |
| dnsseed-policy.md | H A D | 08-Sep-2021 | 2.4 KiB | 55 | 41 |
| external-signer.md | H A D | 08-Sep-2021 | 6 KiB | 172 | 114 |
| files.md | H A D | 08-Sep-2021 | 9.5 KiB | 129 | 89 |
| fuzzing.md | H A D | 08-Sep-2021 | 14.9 KiB | 263 | 216 |
| gitian-building.md | H A D | 08-Sep-2021 | 251 | 5 | 3 |
| guix.md | H A D | 08-Sep-2021 | 94 | 4 | 2 |
| i2p.md | H A D | 08-Sep-2021 | 4.5 KiB | 107 | 80 |
| init.md | H A D | 08-Sep-2021 | 6.4 KiB | 147 | 105 |
| multiprocess.md | H A D | 08-Sep-2021 | 5.9 KiB | 73 | 56 |
| productivity.md | H A D | 08-Sep-2021 | 10.2 KiB | 219 | 150 |
| psbt.md | H A D | 08-Sep-2021 | 8.1 KiB | 144 | 124 |
| reduce-memory.md | H A D | 08-Sep-2021 | 3.4 KiB | 55 | 35 |
| reduce-traffic.md | H A D | 08-Sep-2021 | 2.4 KiB | 57 | 41 |
| release-notes.md | H A D | 08-Sep-2021 | 77.7 KiB | 1,164 | 1,090 |
| release-process.md | H A D | 08-Sep-2021 | 16.1 KiB | 330 | 227 |
| shared-libraries.md | H A D | 08-Sep-2021 | 3.2 KiB | 51 | 38 |
| tor.md | H A D | 08-Sep-2021 | 10.1 KiB | 226 | 162 |
| translation_process.md | H A D | 08-Sep-2021 | 5.5 KiB | 102 | 71 |
| translation_strings_policy.md | H A D | 08-Sep-2021 | 4 KiB | 101 | 63 |
| zmq.md | H A D | 08-Sep-2021 | 6.6 KiB | 156 | 118 |
README.md
1Bitcoin Core
2=============
3
4Setup
5---------------------
6Bitcoin 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.
7
8To download Bitcoin Core, visit [bitcoincore.org](https://bitcoincore.org/en/download/).
9
10Running
11---------------------
12The following are some helpful notes on how to run Bitcoin Core on your native platform.
13
14### Unix
15
16Unpack the files into a directory and run:
17
18- `bin/bitcoin-qt` (GUI) or
19- `bin/bitcoind` (headless)
20
21### Windows
22
23Unpack the files into a directory, and then run bitcoin-qt.exe.
24
25### macOS
26
27Drag Bitcoin Core to your applications folder, and then run Bitcoin Core.
28
29### Need Help?
30
31* See the documentation at the [Bitcoin Wiki](https://en.bitcoin.it/wiki/Main_Page)
32for help and more information.
33* Ask for help on [Bitcoin StackExchange](https://bitcoin.stackexchange.com).
34* Ask for help on #bitcoin on Libera Chat. If you don't have an IRC client, you can use [web.libera.chat](https://web.libera.chat/#bitcoin).
35* Ask for help on the [BitcoinTalk](https://bitcointalk.org/) forums, in the [Technical Support board](https://bitcointalk.org/index.php?board=4.0).
36
37Building
38---------------------
39The 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.
40
41- [Dependencies](dependencies.md)
42- [macOS Build Notes](build-osx.md)
43- [Unix Build Notes](build-unix.md)
44- [Windows Build Notes](build-windows.md)
45- [FreeBSD Build Notes](build-freebsd.md)
46- [OpenBSD Build Notes](build-openbsd.md)
47- [NetBSD Build Notes](build-netbsd.md)
48- [Android Build Notes](build-android.md)
49- [Gitian Building Guide (External Link)](https://github.com/bitcoin-core/docs/blob/master/gitian-building.md)
50
51Development
52---------------------
53The Bitcoin repo's [root README](/README.md) contains relevant information on the development process and automated testing.
54
55- [Developer Notes](developer-notes.md)
56- [Productivity Notes](productivity.md)
57- [Release Notes](release-notes.md)
58- [Release Process](release-process.md)
59- [Source Code Documentation (External Link)](https://doxygen.bitcoincore.org/)
60- [Translation Process](translation_process.md)
61- [Translation Strings Policy](translation_strings_policy.md)
62- [JSON-RPC Interface](JSON-RPC-interface.md)
63- [Unauthenticated REST Interface](REST-interface.md)
64- [Shared Libraries](shared-libraries.md)
65- [BIPS](bips.md)
66- [Dnsseed Policy](dnsseed-policy.md)
67- [Benchmarking](benchmarking.md)
68
69### Resources
70* Discuss on the [BitcoinTalk](https://bitcointalk.org/) forums, in the [Development & Technical Discussion board](https://bitcointalk.org/index.php?board=6.0).
71* Discuss project-specific development on #bitcoin-core-dev on Libera Chat. If you don't have an IRC client, you can use [web.libera.chat](https://web.libera.chat/#bitcoin-core-dev).
72
73### Miscellaneous
74- [Assets Attribution](assets-attribution.md)
75- [bitcoin.conf Configuration File](bitcoin-conf.md)
76- [Files](files.md)
77- [Fuzz-testing](fuzzing.md)
78- [I2P Support](i2p.md)
79- [Init Scripts (systemd/upstart/openrc)](init.md)
80- [PSBT support](psbt.md)
81- [Reduce Memory](reduce-memory.md)
82- [Reduce Traffic](reduce-traffic.md)
83- [Tor Support](tor.md)
84- [ZMQ](zmq.md)
85
86License
87---------------------
88Distributed under the [MIT software license](/COPYING).
89
README_doxygen.md
1\mainpage notitle
2
3\section intro_sec Introduction
4
5This is the developer documentation of the reference client for an experimental new digital currency called Bitcoin,
6which enables instant payments to anyone, anywhere in the world. Bitcoin uses peer-to-peer technology to operate
7with no central authority: managing transactions and issuing money are carried out collectively by the network.
8
9The software is a community-driven open source project, released under the MIT license.
10
11See https://github.com/bitcoin/bitcoin and https://bitcoincore.org/ for further information about the project.
12
13\section Navigation
14Use <a href="modules.html"><code>Modules</code></a>, <a href="namespaces.html"><code>Namespaces</code></a>, <a href="classes.html"><code>Classes</code></a>, or <a href="files.html"><code>Files</code></a> at the top of the page to start navigating the code.
15
16