From 749306b6ff6520fffe37e8fb5b78c1b15005f4cb Mon Sep 17 00:00:00 2001 From: ismaelsadeeq Date: Wed, 27 May 2026 12:28:27 +0100 Subject: [PATCH] doc: update README for 2140-dev/bitcoin --- README.md | 32 ++++++++++++-------------------- 1 file changed, 12 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index f1889c6a699e..832e8edc9862 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,14 @@ -Bitcoin Core integration/staging tree -===================================== +2140-dev/bitcoin +================ -https://bitcoincore.org +> [!WARNING] +> This software contains experimental features and is not recommended for general use. Run it at your own risk. We run this node ourselves to verify our experiments. We do not distribute binaries; you must build from source (see `doc/build-*.md`). -For an immediately usable, binary version of the Bitcoin Core software, see -https://bitcoincore.org/en/download/. + +> [!NOTE] +> This repository is a fork of Bitcoin Core maintained by the [2140](https://2140.dev) team. It is a staging ground for bigger, more intrusive ideas that we develop end-to-end before proposing them upstream to [bitcoin/bitcoin](https://github.com/bitcoin/bitcoin). We take a move-fast-break-things approach to work through edge cases and validate ideas thoroughly. + +This repository is not limited to the 2140 team; anyone is welcome to propose ideas and open pull requests here. What is Bitcoin Core? --------------------- @@ -23,14 +27,7 @@ information or see https://opensource.org/license/MIT. Development Process ------------------- -The `master` branch is regularly built (see `doc/build-*.md` for instructions) and tested, but it is not guaranteed to be -completely stable. [Tags](https://github.com/bitcoin/bitcoin/tags) are created -regularly from release branches to indicate new official, stable release versions of Bitcoin Core. - -The https://github.com/bitcoin-core/gui repository is used exclusively for the -development of the GUI. Its master branch is identical in all monotree -repositories. Release branches and tags do not exist, so please do not fork -that repository unless it is for development reasons. +The `master` branch is regularly built (see `doc/build-*.md` for instructions) and tested, but it is not guaranteed to be completely stable. The contribution workflow is described in [CONTRIBUTING.md](CONTRIBUTING.md) and useful hints for developers can be found in [doc/developer-notes.md](doc/developer-notes.md). @@ -38,10 +35,7 @@ and useful hints for developers can be found in [doc/developer-notes.md](doc/dev Testing ------- -Testing and code review is the bottleneck for development; we get more pull -requests than we can review and test on short notice. Please be patient and help out by testing -other people's pull requests, and remember this is a security-critical project where any mistake might cost people -lots of money. +Testing and code review is important; please help out by testing other people's pull requests. This is experimental software; changes may be unstable or incomplete. ### Automated Testing @@ -50,8 +44,7 @@ submit new unit tests for old code. Unit tests can be compiled and run (assuming they weren't disabled during the generation of the build system) with: `ctest`. Further details on running and extending unit tests can be found in [/src/test/README.md](/src/test/README.md). - -The CI (Continuous Integration) systems make sure that every pull request is tested on Windows, Linux, and macOS. +The CI (Continuous Integration) systems make sure that every pull request is tested on Linux and macOS. The CI must pass on all commits before merge to avoid unrelated CI failures on new pull requests. ### Manual Quality Assurance (QA) Testing @@ -60,4 +53,3 @@ Changes should be tested by somebody other than the developer who wrote the code. This is especially important for large or high-risk changes. It is useful to add a test plan to the pull request description if testing the changes is not straightforward. -