diff --git a/doc/dependencies.md b/doc/dependencies.md --- a/doc/dependencies.md +++ b/doc/dependencies.md @@ -1,7 +1,7 @@ Dependencies ============ -These are the dependencies currently used by Bitcoin ABC. You can find instructions for installing them in the `build-*.md` file for your platform. +These are the dependencies currently used by Bitcoin ABC. You can find instructions for installing them in the [`build-*.md`](../INSTALL.md) file for your platform. | Dependency | Version used | Minimum required | CVEs | Shared | [Bundled Qt library](https://doc.qt.io/qt-5/configure-options.html) | | --- | --- | --- | --- | --- | --- | diff --git a/doc/developer-notes.md b/doc/developer-notes.md --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -232,9 +232,9 @@ ### Writing tests -For details on unit tests, see `unit-tests.md` +For details on unit tests, see [Compiling/running unit tests](unit-tests.md). -For details on functional tests, see `functional-tests.md` +For details on functional tests, see [Functional tests](functional-tests.md). ### Writing script integration tests @@ -789,7 +789,7 @@ Prefer to offload work from the GUI thread to worker threads (see `RPCExecutor` in console code as an example) or take other steps (see - https://doc.qt.io/archives/qq/qq27-responsive-guis.html) to keep the GUI + ) to keep the GUI responsive. - *Rationale*: Blocking the GUI thread can increase latency, and lead to @@ -813,16 +813,16 @@ Current third party libraries include: - src/leveldb - - Upstream at https://github.com/google/leveldb ; Maintained by Google. + - Upstream at ; Maintained by Google. - **Note**: Follow the instructions in [Upgrading LevelDB](#upgrading-leveldb) when merging upstream changes to Bitcoin ABC. - src/libsecp256k1 - - Upstream at https://github.com/bitcoin-core/secp256k1/ ; actively maintained + - Upstream at ; actively maintained by Bitcoin Core contributors. Bitcoin ABC is using a modified version of libsecp256k1, some changes might be directly submitted to Bitcoin ABC. - See the [secp256k1 README](/src/secp256k1/README.md) for details. + See the [secp256k1 README](../src/secp256k1/README.md) for details. - src/crypto/ctaes - Upstream at https://github.com/bitcoin-core/ctaes ; maintained by Bitcoin @@ -881,11 +881,11 @@ Git and GitHub tips --------------------- -- Github is not typically the source of truth for pull requests. See CONTRIBUTING.md for instructions +- Github is not typically the source of truth for pull requests. See [CONTRIBUTING](../CONTRIBUTING.md) for instructions on setting up your repo correctly. - Similarly, your git remote origin should be set to: `ssh://vcs@reviews.bitcoinabc.org:2221/source/bitcoin-abc.git` - instead of github.com. See CONTRIBUTING.md for details. + instead of github.com. See [CONTRIBUTING](../CONTRIBUTING.md). - For resolving merge/rebase conflicts, it can be useful to enable diff3 style using `git config merge.conflictstyle diff3`. Instead of