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

Other technical dependencies could be added to the README file in the go-ipfs-as-a-library example #7298

Open
ismcuacor opened this issue May 10, 2020 · 6 comments
Labels
help wanted Seeking public contribution on this issue P3 Low: Not priority right now status/accepted This issue has been accepted topic/docs-ipfs Topic docs-ipfs

Comments

@ismcuacor
Copy link

ismcuacor commented May 10, 2020

Location

go-ipfs/docs/examples/go-ipfs-as-a-library/README.md

Description

During the README, it would be probably useful to include other technical dependencies. I have identified:

  • GCC
  • build-essential (in alpine linux, alpine-sdk)

This is a minor issue, but it may help users not so confident with the command line.

@ismcuacor ismcuacor added need/triage Needs initial labeling and prioritization topic/docs-ipfs Topic docs-ipfs labels May 10, 2020
@welcome
Copy link

welcome bot commented May 10, 2020

Thank you for submitting your first issue to this repository! A maintainer will be here shortly to triage and review.
In the meantime, please double-check that you have provided all the necessary information to make this process easy! Any information that can help save additional round trips is useful! We currently aim to give initial feedback within two business days. If this does not happen, feel free to leave a comment.
Please keep an eye on how this issue will be labeled, as labels give an overview of priorities, assignments and additional actions requested by the maintainers:

  • "Priority" labels will show how urgent this is for the team.
  • "Status" labels will show if this is ready to be worked on, blocked, or in progress.
  • "Need" labels will indicate if additional input or analysis is required.

Finally, remember to use https://discuss.ipfs.io if you just need general support.

@ribasushi
Copy link
Contributor

@ismcuacor the core of go-ipfs should be buildable entirely without gcc available. Could you elaborate which part needed it in your case?

@ismcuacor
Copy link
Author

Oups, my bad. I actually meant the README.me in the go-ipfs-as-a-example (go-ipfs/docs/examples/go-ipfs-as-a-library/), for which GCC is indeed necessary.

I changed the title accordingly to about more confusion

@ismcuacor ismcuacor changed the title Other technical dependencies could be added to the README file Other technical dependencies could be added to the README file in the go-ipfs-as-a-library example May 10, 2020
@ribasushi
Copy link
Contributor

@ismcuacor ah I see. Do you think you could propose a small patch with the wording/listing that would have helped you last week?

@Stebalien
Copy link
Member

GCC shouldn't be necessary for that example either.

I'd like to avoid including instructions on how to setup build dependencies on specific platforms:

  • They tend to get out of date very quickly.
  • Users should already have setup a go toolchain before they try building the example.

What we could do is link to https://golang.org/doc/install.

@ismcuacor
Copy link
Author

Yes, that'd work

@Stebalien Stebalien added help wanted Seeking public contribution on this issue P3 Low: Not priority right now status/accepted This issue has been accepted and removed need/triage Needs initial labeling and prioritization labels May 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Seeking public contribution on this issue P3 Low: Not priority right now status/accepted This issue has been accepted topic/docs-ipfs Topic docs-ipfs
Projects
None yet
Development

No branches or pull requests

3 participants