Reworked the readme.

Aaron Jacobs 8 years ago
parent 563f47c299
commit 9564710706

@ -1,31 +1,30 @@
This package allows for writing and mounting user-space file systems from Go. It
is a wrapper around [][bazil], which does the heavy lifting. It
does not make use of the [][bazil-fs] sub-package, which allows
for something like an object-orientend representation of files and directories,
and contains a decent amount of canned behavior.
This package allows for writing and mounting user-space file systems from Go.
Install it as follows:
The chief improvements and/or differences from the packages are:
go get -u
* No surprises in the form of magic/default behaviors. You must provide an
implementation for every method in the interface. Embed a
`fuseutil.NotImplementedFileSystem` struct to have default implementations
that return `ENOSYS`.
Afterward, see the documentation for the following three packages:
* Every method, struct, and field is thoroughly documented. This may help you
get your bearings in the world of FUSE, the Linux VFS, traditional file
system implementations, etc., all of which tend to be very poorly
* Package [fuse][] provides support for mounting a new file system and
reading requests from the kernel.
* Support for arbitrary offsets in directory entries returned by `ReadDir`.
(The package assumes that offsets must be counts of bytes.)
* Package [fuseops][] enumerates the supported requests from the kernel, and
provides documentation on their semantics.
The very large disadvantage over using the packages is that many
features have not yet been exposed.
* Package [fuseutil][], in particular the `FileSystem` interface, provides a
convenient way to create a file system type and export it to the kernel via
Make sure to see the sub-packages of the [samples][] package.
Make sure to also see the sub-packages of the [samples][] package for examples
and tests.
This package owes its inspiration and most of its kernel-related code to