mirror of https://github.com/bitcoin/bitcoin.git synced 2026-01-19 06:43:45 +01:00

Files

fanquake 18017152c2 Merge #20619 : guix: Quality of life improvements

570e43fe72 guix: Print build params inside/outside of container (Carl Dong)
2f9d1fdde6 guix: Move DISTSRC determination to guix-build.sh (Carl Dong)
0b7cd07bb5 guix: Move OUTDIR determination+creation to guix-build.sh (Carl Dong)
d27ff8b86a guix: Add more sanity checks to guix-build.sh (Carl Dong)
57f9533146 guix: Add section headings to guix-build.sh (Carl Dong)
38b7b2ed72 genbuild: Specify rev-parse length (Carl Dong)
036dc740da docs: Point to contrib/guix/README.md in doc/guix.md (Carl Dong)
34f0fda2d3 guix: Small updates to README wording (Carl Dong)
402e3a5b1e guix: Update HOSTS README entry for new architectures (Carl Dong)
cfa7ceb21b guix: Remove README development environment section (Carl Dong)
93b6a8544a guix: Add ADDITIONAL_GUIX_{COMMON,TIMEMACHINE}_FLAGS options (Carl Dong)
0f31e24703 guix: Add SUBSTITUTE_URLS option (Carl Dong)
444fcfca90 guix: Make guix honor MAX_JOBS setting (Carl Dong)

Pull request description:

  After live-demo-ing a Guix build (which completed successfully!) on achow101's stream, I realized there were a few quality of life improvements which can be made to improve the user experience of our Guix build process. Here are a few of them.

  Notable changes:
  1. When `MAX_JOBS` is specified, both `guix time-machine` and `guix environment` will now build up to `MAX_JOBS` packages at a time when creating the build environment
  2. The instructions for using substitutes were incorrect, and has now been replaced with a `SUBSTITUTE_URLS` environment variable, which works well with shell's IFS splitting rules
  3. New `ADDITIONAL_GUIX_{COMMON,TIMEMACHINE}_FLAGS` options, for more granular customization of the build process.
  4. README cleanup

ACKs for top commit:
  fanquake:
    ACK 570e43fe72 - lets move this forward.

Tree-SHA512: 4e8ab560522ade5efb5e8736aec0fb1a3f19ae9deb586c1ab87020816876f3f466a950b3f8c04d9fa1d072ae5ee780038c5c9063577049bdd9db17978e11c328

2021-01-12 18:53:35 +08:00

man

doc: Remove generated manual pages from master branch

2020-11-18 11:12:46 +01:00

release-notes

doc: Add historical release notes for 0.20.1

2020-08-01 14:17:14 +02: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

Replace current benchmarking framework with nanobench

2020-06-13 12:24:18 +02:00

bips.md

docs: mention BIPs 340-342 in doc/bips.md

2020-10-15 14:20:20 -07:00

bitcoin_logo_doxygen.png

Lossless image optimization

2013-12-02 10:10:22 +01:00

bitcoin-conf.md

doc: add default bitcoin.conf locations

2019-08-19 19:34:57 +02:00

build-freebsd.md

doc: Update for FreeBSD 12.2, add GUI Build Instructions

2020-12-10 15:38:20 -05:00

build-netbsd.md

doc: mention MAKE=gmake workaround when building on a BSD

2020-03-18 07:55:07 +08:00

build-openbsd.md

doc: Add bash as an OpenBSD dependency

2020-11-26 21:34:25 +01:00

build-osx.md

doc: Add explicit macdeployqtplus dependencies install step

2021-01-09 09:37:12 +02:00

build-unix.md

doc: Add libnatpmp stuff

2021-01-07 18:07:10 +02:00

build-windows.md

Add Windows WSL build recommendation to temporarily disable Win32 PE support.

2020-06-29 13:25:59 +01:00

dependencies.md

doc: Add libnatpmp stuff

2021-01-07 18:07:10 +02:00

descriptors.md

docs/descriptors.md: Remove hardened marker in the path after xpub

2020-11-06 14:27:47 +05:00

developer-notes.md

doc: Use https URLs where possible

2021-01-04 12:23:16 +08:00

dnsseed-policy.md

Correct spelling mistakes in doc folder

2015-10-18 06:25:43 +10:00

Doxyfile.in

[doc] include Doxygen comments for HAVE_BOOST_PROCESS

2020-07-31 13:38:10 +02:00

files.md

Merge #20152 : doc: Update wallet files in files.md

2020-10-27 15:43:53 +08:00

fuzzing.md

fuzz: Link all targets once

2020-12-10 07:15:42 +01:00

gitian-building.md

doc: move gitian building to external repo

2017-09-25 15:45:38 +02:00

guix.md

docs: Point to contrib/guix/README.md in doc/guix.md

2021-01-08 11:40:01 -05:00

init.md

fixing documentation to not require rpcpassword

2020-03-21 19:51:31 +05:30

JSON-RPC-interface.md

Update 'Secure string handling'

2020-12-29 01:49:30 +05:30

multiprocess.md

build: multiprocess autotools changes

2020-05-12 09:47:06 -04:00

productivity.md

doc: Add libnatpmp stuff

2021-01-07 18:07:10 +02:00

psbt.md

doc: fix/improve analyzepsbt in doc/psbt.md

2019-05-19 17:31:37 +02: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

README.md

doc: Update webchat URLs in README.md

2020-04-02 13:09:55 +00:00

reduce-memory.md

doc: block-relay-only is not blocksonly

2020-03-30 09:09:12 -04:00

reduce-traffic.md

doc: Use precise permission flags where possible

2020-07-10 15:37:42 +02:00

release-notes-18077.md

doc: Add release notes

2021-01-07 18:07:11 +02:00

release-notes-19776.md

doc: release note for new getpeerinfo fields "bip152_hb_{from,to}"

2020-09-29 00:42:06 +02:00

release-notes.md

[doc] Add release notes for removed getpeerinfo fields.

2020-12-26 13:30:54 -08:00

release-process.md

doc: Drop mentions of Travis CI as it is no longer used

2020-12-18 01:15:53 +02:00

REST-interface.md

Merge #19050 : doc: Add warning for rest interface limitation

2020-12-17 10:00:38 +01:00

shared-libraries.md

doc: libbitcoinconsensus: add missing error code description, fix NBitcoin link

2020-12-05 13:37:00 +01:00

tor.md

doc: Add libnatpmp stuff

2021-01-07 18:07:10 +02:00

translation_process.md

build: Factor out qt translations from build system

2019-09-29 14:24:54 +02:00

translation_strings_policy.md

doc: Do not translate technical or extremely rare errors

2020-05-05 04:46:08 +03:00

zmq.md

doc: Adjust ZMQ usage to support multiple interfaces

2020-09-23 23:14:28 +02: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.