djdv / go-filesystem-utils

ISC License
10 stars 2 forks source link

missing README #10

Closed djdv closed 1 year ago

djdv commented 1 year ago

We should describe how to build the thing and what it's for.

We have a utility for building that does some checks: go run ./cmd/build Need to list dependencies and whatnot.

The purpose is essentially to mount Go's fs.FS interface over a range of host and target APIs. We implement some of these right now for things like IPFS, FUSE, and 9P with plans to extend as requested.

djdv commented 1 year ago

We don't really need one anymore. There's a docs directory that explains how to build, and the CI takes care of this anyway.