commit | bd2f203f01e7fbd61aa555c4b2286d044a3cf74f | [log] [tgz] |
---|---|---|
author | Mitchell Hashimoto <mitchell.hashimoto@gmail.com> | Tue Aug 19 11:48:28 2014 -0700 |
committer | Mitchell Hashimoto <mitchell.hashimoto@gmail.com> | Tue Aug 19 11:48:28 2014 -0700 |
tree | d4c45b66e36f7114450e7982042d1032eec1c3fe | |
parent | ecd092285bca919660776da59d2046fa54a62ac4 [diff] |
Update README
This is a Go library for detecting the user's home directory without the use of cgo, so the library can be used in cross-compilation environments.
Usage is incredibly simple, just call homedir.Dir()
to get the home directory for a user, and homedir.Expand()
to expand the ~
in a path to the home directory.
Why not just user os/user
? The built-in os/user
package requires cgo on Darwin systems. This means that any Go code that uses that package cannot cross compile. But 99% of the time the use for os/user
is just to retrieve the home directory, which we can do for the current user without cgo. This library does that, enabling cross-compilation.