diff --git a/README.md b/README.md index e69de29..e11e7ce 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,26 @@ +# x-way mutt + +This tap contains the mutt 1.5.24 formula with updated versions of patches no longer included in the official homebrew repository (currently only the trash_folder patch). + +## How do I install this formula? + +Just `brew tap x-way/mutt` and then `brew install x-way/mutt/mutt`. + +You can also install via URL: +``` +brew install https://raw.githubusercontent.com/x-way/homebrew-mutt/master/mutt.rb +``` + +## Troubleshooting +First, please run `brew update` and `brew doctor`. + +Second, read the [Troubleshooting Checklist](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Troubleshooting.md#troubleshooting). + +**If you don’t read these it will take far longer to help you with your problem.** + +## More Documentation + +`brew help`, `man brew` or check [our documentation](https://github.com/Homebrew/homebrew/tree/master/share/doc/homebrew#readme). + +## License +Code is under the [BSD 2 Clause (NetBSD) license](https://github.com/x-way/homebrew-mutt/tree/master/LICENSE.txt).