Skip to content

Add build instructions to README.md #92

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.

Sign up for GitHub

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

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

Add build instructions to README.md #92

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f6711e1
add build instructions
gmelodie Aug 1, 2022
97f213b
Update README.md
gmelodie Aug 1, 2022
f66b13f
Update README.md
gmelodie Aug 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,19 @@

A standalone client library for interacting with the filecoin storage network

## Usage
Building the CLI:
```bash
make
cd filc
go build
Comment on lines +8 to +10
Copy link
Contributor

@elijaharita elijaharita Aug 8, 2022

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

@elijaharita elijaharita Aug 8, 2022

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

```


## Features

Expand Down