aboutsummaryrefslogtreecommitdiff
path: root/doc/README.md
AgeCommit message (Collapse)Author
2022-09-15doc: consolidate & remove release-note fragmentsfanquake
These have been moved here: https://github.com/bitcoin-core/bitcoin-devwiki/wiki/24.0-Release-Notes-draft.
2022-06-22Merge bitcoin/bitcoin#24352: Add doc/design/libraries.mdlaanwj
dc1e7ad7a5713d885f70ccc6c93e7a4c07e76559 Add doc/design/libraries.md (Ryan Ofsky) Pull request description: Prompted by the [libbitcoinkernel issue #24303](https://github.com/bitcoin/bitcoin/issues/24303) and PRs, I started looking at existing libraries and what their dependencies are and wrote this document to describe them and where `libbitcoinkernel` fits in. Readable link is: https://github.com/ryanofsky/bitcoin/blob/pr/libs/doc/design/libraries.md Feedback is welcome ACKs for top commit: laanwj: ACK dc1e7ad7a5713d885f70ccc6c93e7a4c07e76559 hebasto: Approach ACK dc1e7ad7a5713d885f70ccc6c93e7a4c07e76559, using this doc as a guide in https://github.com/hebasto/bitcoin/pull/3 :) Tree-SHA512: 7687b1847797c50de1f5ea721bd201cc8304690064743fbe6d69e2198cc239084e9da7d158be65bea948a6ec3d71d74c84122c0e523c390b389b49ea8d2cddc9
2022-03-24doc, init: add links to doc/cjdns.mdJon Atack
2022-02-15Add doc/design/libraries.mdRyan Ofsky
2022-02-11net: open p2p connections to nodes that listen on non-default portsVasil Dimov
By default, for mainnet, the p2p listening port is 8333. Bitcoin Core has a strong preference for only connecting to nodes that listen on that port. Remove that preference because connections over clearnet that involve port 8333 make it easy to detect, analyze, block or divert Bitcoin p2p traffic before the connection is even established (at TCP SYN time). For further justification see the OP of: https://github.com/bitcoin/bitcoin/pull/23306
2021-12-15Merge bitcoin/bitcoin#22674: validation: mempool validation and submission ↵W. J. van der Laan
for packages of 1 child + parents 046e8ff264be6b888c0f9a9d822e32aa74e19b78 [unit test] package submission (glozow) e12fafda2dfbbdf63f125e5af797ecfaa6488f66 [validation] de-duplicate package transactions already in mempool (glozow) 8310d942e046c5a9b6bd90afdcd3af68dd91e081 [packages] add sanity checks for package vs mempool limits (glozow) be3ff151a1f9665720cdf70d072b098a2f9726a9 [validation] full package accept + mempool submission (glozow) 144a29099a865ac1dc3e5291d9529fbcca9c83a4 [policy] require submitted packages to be child-with-unconfirmed-parents (glozow) d59ddc5c3d1c035474d7bc9fa9f8a0eeb1c8498c [packages/doc] define and document package rules (glozow) ba26169f6035c238378a3c9647213328a006fa23 [unit test] context-free package checks (glozow) 9b2fdca7f03911ac40fe0f8a0b5da534bee4554b [packages] add static IsChildWithParents function (glozow) Pull request description: This is 1 chunk of [Package Mempool Accept](https://gist.github.com/glozow/dc4e9d5c5b14ade7cdfac40f43adb18a); it restricts packages to 1 child with its parents, doesn't allow conflicts, and doesn't have CPFP (yet). Future PRs (see #22290) will add RBF and CPFP within packages. ACKs for top commit: laanwj: Code review ACK 046e8ff264be6b888c0f9a9d822e32aa74e19b78 Tree-SHA512: 37dbba37d527712f8efef71ee05c90a8308992615af35f5e0cfeafc60d859cc792737d125aac526e37742fe7683ac8c155ac24af562426213904333c01260c95
2021-12-14Merge bitcoin/bitcoin#22822: doc: Add multisig tutorialMarcoFalke
1ef2c034523d0dfc36c84186d7a110cfc7de238b Add multisig tutorial (lsilva01) Pull request description: This PR adds a mutisig tutorial, as requested in https://github.com/bitcoin/bitcoin/issues/21278 Although there is already a brief explanation and a functional test about the multisig implemented in https://github.com/bitcoin/bitcoin/pull/22067, this tutorial proposes to use the signet (instead of regtest), bringing the reader closer to a real environment and explaining some functions in more detail. I'm not sure if this format should be in this repository or on some wiki page. But as there is an open issue regarding this matter, that is my suggestion. ACKs for top commit: Sjors: re-utACK 1ef2c034523d0dfc36c84186d7a110cfc7de238b prayank23: ACK https://github.com/bitcoin/bitcoin/pull/22822/commits/1ef2c034523d0dfc36c84186d7a110cfc7de238b Tree-SHA512: 2c3f17a8c50e554f802029dceb28ab90a77021f135b8cbd77dca3879ba1f1a0eac6bda0afb90d1ff6b8116fb0628471687d3fb77bb255ef5d8b9590b775cbce9
2021-12-13Add multisig tutoriallsilva01
2021-11-29[packages/doc] define and document package rulesglozow
Central place for putting package-related info. This document or parts of it can also be easily ported to other places if deemed appropriate.
2021-10-04doc: add assumeutxo notesJames O'Beirne
2021-08-31release: remove gitianfanquake
2021-08-19doc: link to managing-wallets from doc readmefanquake
This was forgotten in #22523.
2021-06-27doc: doc/README.md IRC updatesJon Atack
- update remaining link and reference from freenode to libera - remove no-longer-existing #bitcoin-dev IRC channel - other minor fixups
2021-06-23doc: sort entries in doc/README.md#Miscellaneous alphabeticallyVasil Dimov
2021-06-23doc: add basic I2P documentationVasil Dimov
2021-05-31doc: Fix external links (IRC, ...)MarcoFalke
2021-03-21Qt: add Android packaging supportIgor Cota
Introduce an android directory under qt and allow one to package bitcoin-qt for Android by running make apk. Add bitcoin-qt Android build instructions.
2020-04-02doc: Update webchat URLs in README.mdSuriyaa Sundararuban
2019-11-25doc: Change doxygen URL to doxygen.bitcoincore.orgWladimir J. van der Laan
The bitcoin core doxygen documentation has moved to https://doxygen.bitcoincore.org, see bitcoin-core/bitcoincore.org#681 (the old URL still works as a redirect)
2019-11-18doc: remove OpenSSL from build instructions and licensing infofanquake
2019-07-06docs: add reduce-memory.mdfanquake
Co-Authored-By: Wladimir J. van der Laan <laanwj@gmail.com>
2019-04-05travis: Properly cache and error on timeoutMarcoFalke
2019-02-05doc: Add separate productivity notes documentCarl Dong
Many developers have their own tools and tricks to be more productive during their cycles, so let's document the best ones so that everyone can benefit from them.
2019-01-10Merge #15132: docs: Add FreeBSD build notes link to doc/README.mdMarcoFalke
5282608e92 docs: Add FreeBSD build notes link to doc/README.md (fanquake) Pull request description: Tree-SHA512: c845dc0a2a31f0507a64da5232579d6f009789722273891c668d15ee8adb10244ab8573ce2b7c9c442e8d2ed6c90fb7acfb59c2ac9e9af9247e070bb8d501eda
2019-01-09docs: Add FreeBSD build notes link to doc/README.mdfanquake
2019-01-08Fix download linkMartin Erlandsson
2018-10-30doc: Add external interface consistency guaranteesMarcoFalke
2018-10-22Merge #14511: doc: Remove explicit storage requirement from README.mdPieter Wuille
5918204304 Removed explicit mention of storage requirement (squashed) (Martin Erlandsson) Pull request description: Similarly discussed and fixed in the following bitcoin.org issue: https://github.com/bitcoin-dot-org/bitcoin.org/pull/2716 Tree-SHA512: 3d1e0b1e70c2e2a5003f437c7deba8bc72f487852948c298db154aaf29184fa407e122ab7fdff9bfb4e52cc6062bc2d2122bbbdf805283aed21aa685cf29681c
2018-10-22Removed explicit mention of storage requirement (squashed)Martin Erlandsson
Similarly discussed and fixed in the following bitcoin.org issue: https://github.com/bitcoin-dot-org/bitcoin.org/pull/2716 Removed mention of storage requirement Agreeing with @laanwj that this mention of the storage requirement could be removed, I did so and changed the wording accordingly. Would be nice to be able to add a link to a canonical source that is always updated, for those who want a number. Update doc/README.md Co-Authored-By: merland <martin@megabit.se> Update README.md added a missing 'a'
2018-10-20Merge #14497: docs: Add doc/bitcoin-conf.mdWladimir J. van der Laan
1fb3c167c3cbd4a432a064b299439b3430157dda Add `doc/bitcoin-conf.md` (Hennadii Stepanov) Pull request description: From the IRC: > 2018-10-16T05:35:03 \<wumpus\> if something can be solved by better documentation, please work on documentation! > 2018-10-16T05:35:12 \<wumpus\> don't change the code instead Refs: - #14370 - #14427 - #14494 Based on the BITCOIN.CONF(5) manual page written by Micah Anderson \<micah@debian.org\> for the Debian system. Tree-SHA512: 16393c9073c027fa1c46f8b59651e60b9a3159b3aeb9b3102040c292d2787f32b1ead5977957ac3ac0759a4bf626650a2325b68ad84320964ac089ffc2d3b4f4
2018-10-19Add `doc/bitcoin-conf.md`Hennadii Stepanov
2018-10-18Textual improvementsMartin Erlandsson
2018-08-14Add PSBT documentationPieter Wuille
2018-08-02trivial: Fixed typos and cleaned up languageWilliam Robinson
2018-06-04Rename “OS X” to the newer “macOS” conventionGiulio Lombardo
2018-01-30Add NetBSD build instruction linksAlex Vear
2017-09-07Create dependencies.md, and link dependencies file from README & build docsflack
2017-04-05doc: Remove version numbers from READMEsWladimir J. van der Laan
If we want to keep these numbers, could generate them using autoconf. But this seems unnecessary.
2017-03-15specify blockchain size & default behaviour (over pruning)Mike van Rossum
2017-02-17build: bump version to 0.14.99Wladimir J. van der Laan
Now that 0.14 branch has been split off, master is 0.14.99 (pre-0.15). Also clean out release notes.
2016-12-15doc: Add bare-bones documentation for fuzzingWladimir J. van der Laan
2016-11-02Merge `doc/unit-tests.md` into `src/test/README.md`Wladimir J. van der Laan
Refer to the right file in the top-level README.md. Having only one file with test documentation saves some confusion about where things are documented.
2016-10-04[doc] Rework docsMarcoFalke
* Minor formatting such as adjusting links * Move sections of `doc/multiwallet-qt.md` to the source code and delete the file, as it is outdated * Fix typo in the release notes * Amend release process to mention update of BLOCK_CHAIN_SIZE
2016-07-18build: bump version to 0.13.99Wladimir J. van der Laan
Now that 0.13 branch has been split off, master is 0.13.99 (pre-0.14).
2016-05-29[Doc] Add benchmarking notesfanquake
2016-05-18doc: 32 and 64 bit packages are seperateWladimir J. van der Laan
2016-05-12doc: Remove outdated qt4 install information from README.mdWladimir J. van der Laan
This text is aimed at users installing the binaries. Now that Qt5 is linked statically, there is no need to install Qt as a run-time dependency.
2016-03-01[doc] Fix markdownMarcoFalke
2015-12-03Now that 0.12 has been branched, master is 0.12.99Wladimir J. van der Laan
... in preparation for 0.13
2015-11-17[doc] Users now see 'Bitcoin Core' in the OSX bundleMichael Ford
On OS X users will see 'Bitcoin Core' after opening the DMG bundle.