b22c6b7a4e
Adds READMEs and enforces vendor is done at repository root Signed-off-by: Derek McGowan <derek@mcgstyle.net>
23 lines
848 B
Markdown
23 lines
848 B
Markdown
# mousetrap
|
|
|
|
mousetrap is a tiny library that answers a single question.
|
|
|
|
On a Windows machine, was the process invoked by someone double clicking on
|
|
the executable file while browsing in explorer?
|
|
|
|
### Motivation
|
|
|
|
Windows developers unfamiliar with command line tools will often "double-click"
|
|
the executable for a tool. Because most CLI tools print the help and then exit
|
|
when invoked without arguments, this is often very frustrating for those users.
|
|
|
|
mousetrap provides a way to detect these invocations so that you can provide
|
|
more helpful behavior and instructions on how to run the CLI tool. To see what
|
|
this looks like, both from an organizational and a technical perspective, see
|
|
https://inconshreveable.com/09-09-2014/sweat-the-small-stuff/
|
|
|
|
### The interface
|
|
|
|
The library exposes a single interface:
|
|
|
|
func StartedByExplorer() (bool)
|