# README

SlothFS is a FUSE filesystem that provides light-weight, lazily downloaded, read-only checkouts of manifest-based Git projects. It is intended for use with Android.

How to use

To start the file system:

go install github.com/google/slothfs/cmd/slothfs-repofs
mkdir /tmp/mnt
slothfs-repofs /tmp/mnt &

To create a workspace "ws" corresponding to the latest manifest version

go install github.com/google/slothfs/cmd/slothfs-deref-manifest
slothfs-deref-manifest > /tmp/m.xml
ln -s /tmp/m.xml /tmp/mnt/config/ws

More details can be found in the manual.

DISCLAIMER

This is not an official Google product.

# Packages

cache

Package cache implements a simplistic persistent cache based on the filesystem.

cmd

No description provided by the author

cookie

cookie parses curl cookie jar files.

fs

No description provided by the author

gitiles

Package gitiles is a client library for the Gitiles source viewer.

manifest

Package manifest manipulates Manifest files as described at https://gerrit.googlesource.com/git-repo/+/master/docs/manifest-format.txt.

populate

Package populate holds the code to augment a partial R/W checkout with a symlink forest into a SlothFS workspace.