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

add macos details, update linux details #520

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

Conversation

dhuseby
Copy link
Contributor

@dhuseby dhuseby commented Feb 25, 2025

Signed-off-by: Dave Grantham [email protected]

What was wrong?

Related to Issue #519

The contributing page didn't have any details on installing the correct dependencies before trying to build it.

Also, missing MacOS details.

How was it fixed?

Added documentation.

To-Do

  • Clean up commit history
  • Add or update documentation related to these changes
  • Add entry to the release notes

Cute Animal Picture

put a cute animal picture link inside the parentheses

Signed-off-by: Dave Grantham <[email protected]>
@dhuseby dhuseby changed the title add macos details, update details add macos details, update linux details Feb 25, 2025
@dhuseby dhuseby requested a review from seetadev February 26, 2025 06:39
Copy link

@seetadev seetadev left a comment

Choose a reason for hiding this comment

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

@dhuseby : HI Dave. Thank you. This is a great update to the py-libp2p documentation! 🎉

  • The explicit listing of dependencies, along with direct links to their official sources, makes it much easier for developers to get started.

  • The inclusion of both Debian Linux and MacOS installation commands ensures broader accessibility.

  • Adding instructions for both virtualenv and Python3 venv is a thoughtful touch, giving developers flexibility in setting up their environments.

  • The MacOS-specific build instructions for linking against GMP are particularly useful and help prevent common setup issues.

I will try the changes on Debian and MacOS machine (3 different OS versions) and will merge the changes by the maintainer's call tonight. Appreciate your effort.

Overall, this is a well-structured and user-friendly improvement that enhances clarity and streamlines the onboarding process for new contributors. 🚀👏

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