Skip to content

doc: added prerequisites to readme#221

Closed
RockRockX2 wants to merge 1 commit intobitcoindevkit:masterfrom
RockRockX2:master
Closed

doc: added prerequisites to readme#221
RockRockX2 wants to merge 1 commit intobitcoindevkit:masterfrom
RockRockX2:master

Conversation

@RockRockX2
Copy link
Contributor

added gcc as a prerequisite.

Copy link
Member

@notmandatory notmandatory left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the suggestion that will be helpful to new devs who haven't already installed gcc.

README.md Outdated
#### Prerequisites

Building BDK requires gcc. If you do not have this installed run:
```` shell
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⛏️ needs to be three back-ticks and no space after.

Suggested change
```` shell
```shell

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sub-section should also be placed at the beginning of the "Install bdk-cli" section.

@notmandatory notmandatory moved this to Ready to Review in BDK-CLI Sep 30, 2025
@coveralls
Copy link

coveralls commented Sep 30, 2025

Pull Request Test Coverage Report for Build 18167582568

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 8.628%

Totals Coverage Status
Change from base Build 17621040142: 0.0%
Covered Lines: 105
Relevant Lines: 1217

💛 - Coveralls

Copy link
Collaborator

@tvpeter tvpeter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

utACK 20305fb

Copy link

@aagbotemi aagbotemi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good job @RockRockX2, I left a suggestion for you to check.

Building BDK requires gcc. If you do not have this installed run:
``` shell
sudo apt-get install build-essential
````
Copy link

@aagbotemi aagbotemi Oct 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be three back-ticks to close the code block.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@RockRockX2, are you still available to fix this comment?

@tvpeter tvpeter added this to the CLI 3.0.0 milestone Feb 26, 2026
@tvpeter
Copy link
Collaborator

tvpeter commented Mar 9, 2026

This PR is closed in favour of #246 because the contributor was unresponsive.

@tvpeter tvpeter closed this Mar 9, 2026
@github-project-automation github-project-automation bot moved this from Ready to Review to Done in BDK-CLI Mar 9, 2026
tvpeter added a commit that referenced this pull request Mar 10, 2026
0725724 docs: Update stated bdk_wallet version (Vihiga Tyonum)
d787fa0 doc: added prerequisites to readme (oscar)

Pull request description:

  <!-- You can erase any parts of this template not applicable to your Pull Request. -->

  ### Description

  This is a continuation of #221

  <!-- Describe the purpose of this PR, what's being adding and/or fixed -->

  ### Notes to the reviewers

  <!-- In this section you can include notes directed to the reviewers, like explaining why some parts
  of the PR were done in a specific way -->
  - Update the stated `bdk_wallet` to 2.x.x
  - Addressed review comments on #221

  ## Changelog notice

  <!-- Notice the release manager should include in the release tag message changelog -->
  <!-- See https://keepachangelog.com/en/1.0.0/ for examples -->

  ### Checklists

  #### All Submissions:

  * [x] I've signed all my commits
  * [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk-cli/blob/master/CONTRIBUTING.md)
  * [x] I ran `cargo fmt` and `cargo clippy` before committing

ACKs for top commit:
  notmandatory:
    ACK 0725724

Tree-SHA512: a0446a915c8c2553ea4612d9e2382e8d3212c73929be9944c9cb965f0fbf2620df339d3284796cf7315bdb65ca5a364a299ba8bfacb3edd3694c2bd796b0fae0
@tvpeter tvpeter removed this from the CLI 3.0.0 milestone Mar 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants