diff --git a/README.md b/README.md index 8c6d556e..c71cef61 100644 --- a/README.md +++ b/README.md @@ -21,3 +21,29 @@ API docs: http://godoc.org/bazil.org/fuse Our thanks to Russ Cox for his fuse library, which this project is based on. + +# Quick Start # + +Recipe using Go Modules (requires Go 1.12 or higher). + + git clone https://github.com/bazil/fuse ;# clone outside of GOPATH + +Build and install 'hellofs': + + cd fuse + go install ./examples/hellofs + +Mount /tmp/hello: + + mkdir /tmp/hello + hellofs /tmp/hello + +Access /tmp/hello from another session: + + $ ls -al /tmp/hello + total 0 + -r--r--r-- 1 root root 13 Jul 31 22:21 hello + + $ cat /tmp/hello/hello + hello, world + diff --git a/go.mod b/go.mod new file mode 100644 index 00000000..9137978a --- /dev/null +++ b/go.mod @@ -0,0 +1,8 @@ +module bazil.org/fuse + +go 1.12 + +require ( + golang.org/x/net v0.0.0-20190724013045-ca1201d0de80 + golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a +) diff --git a/go.sum b/go.sum new file mode 100644 index 00000000..7cf938aa --- /dev/null +++ b/go.sum @@ -0,0 +1,6 @@ +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/net v0.0.0-20190724013045-ca1201d0de80 h1:Ao/3l156eZf2AW5wK8a7/smtodRU+gha3+BeqJ69lRk= +golang.org/x/net v0.0.0-20190724013045-ca1201d0de80/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a h1:1BGLXjeY4akVXGgbC9HugT3Jv3hCI0z56oJR5vAMgBU= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=