Add more documentation.

Change-Id: I82159ee4741ed3a2997f09aeb520ee1efe239319
3 files changed
tree: a3832478bbe75d59f3076901867a3f6262561434
  1. cache/
  2. cmd/
  3. cookie/
  4. docs/
  5. fs/
  6. gitiles/
  7. manifest/
  8. populate/
  9. .gitignore
  10. all.bash
  11. android.json
  12. CONTRIBUTING
  13. LICENSE
  14. README.md
README.md

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-multifs
mkdir /tmp/mnt
slothfs-multifs -gitiles https://android.googlesource.com/ /tmp/mnt &

To create a workspace “ws” corresponding to the latest manifest version

go install github.com/google/slothfs/cmd/slothfs-expand-manifest
slothfs-expand-manifest --gitiles https://android.googlesource.com/ \
   > /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.