vendor/github.com/mitchellh/go-homedir/README.md

   1 # go-homedir
   2
   3 This is a Go library for detecting the user's home directory without
   4 the use of cgo, so the library can be used in cross-compilation environments.
   5
   6 Usage is incredibly simple, just call `homedir.Dir()` to get the home directory
   7 for a user, and `homedir.Expand()` to expand the `~` in a path to the home
   8 directory.
   9
  10 **Why not just use `os/user`?** The built-in `os/user` package requires
  11 cgo on Darwin systems. This means that any Go code that uses that package
  12 cannot cross compile. But 99% of the time the use for `os/user` is just to
  13 retrieve the home directory, which we can do for the current user without
  14 cgo. This library does that, enabling cross-compilation.