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 build instructions to README.md #92

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

gmelodie
Copy link
Contributor

@gmelodie gmelodie commented Aug 1, 2022

No description provided.

@rvagg
Copy link
Collaborator

rvagg commented Aug 2, 2022

Might be best to point to the README in the filc directory instead? The ffi dependency needs setting up and it requires other dependencies and all those complexities are detailed in that README. And, since Makefile handles a lot of the hassle, make filc might be better advice (also in that README).

@alvin-reyes
Copy link
Contributor

I suggest we add the following:

1 - build instruction

git clone <> 
cd filclient
make

2 - How to use

go get github.com/application-research/filclient@latest

followed by how to use

I discussed this with @elijaharita and he'll modify the readme.md to add these.

Comment on lines +8 to +10
make
cd filc
go build
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
make
cd filc
go build
make filc

any reason not to just mention this, since we already have it?


Using it as a golang library:
```bash
go get github.com/application-research/filclient@latest
Copy link
Contributor

Choose a reason for hiding this comment

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

we should probably add some info about the filecoin-ffi setup process

Suggested change
go get github.com/application-research/filclient@latest
go get github.com/application-research/filclient@latest
# Add filecoin-ffi as an extern dependency
git clone https://github.com/filecoin-project/filecoin-ffi extern/filecoin-ffi
cd extern/filecoin-ffi
git checkout [filclient's dependency version]
make
cd ../..
go mod edit -replace github.com/filecoin-project/filecoin-ffi=./extern/filecoin-ffi

this process is really terrible and i wish we could do something about it

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.

4 participants