Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #5872

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

cipherzzz
Copy link

This pull request includes a small change to the README.md file. The change adds instructions to install necessary build tools before building the project.

  • README.md: Added a step to install necessary build tools (GCC or Clang) before building the project.

Build will fail if compiler is not present - could be confusing for newbies.
@cipherzzz cipherzzz requested a review from a team as a code owner February 27, 2025 21:00
Comment on lines +45 to +46
# Make sure you have necessary build tools installed ie. GCC or Clang
sudo apt-get install build-essential
Copy link
Collaborator

Choose a reason for hiding this comment

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

If the goal here is an os specific example for installing dependencies/building, it should be in a dedicated debian README in the docs folder. However, that would also predicate on having similar readme's for other OS (i.e. windows/mac/rpm based dist etc)

Copy link
Collaborator

@wileyj wileyj left a comment

Choose a reason for hiding this comment

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

rebase against develop please

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants