README: duplicate more of Homebrew/brew README.md

This makes the homebrew-core CONTRIBUTING.md reachable from README.md

Closes #35

Closes #38.

Signed-off-by: ilovezfs <ilovezfs@icloud.com>
master
ilovezfs 2016-04-04 02:12:02 -07:00
parent 06ef2c1fbf
commit 79db2a89f3
1 changed files with 8 additions and 1 deletions

View File

@ -5,12 +5,19 @@ Core formulae for the Homebrew package manager.
Just `brew install <formula>`. This is the default tap for Homebrew and is installed by default.
## Troubleshooting
First, please run `brew update` and `brew doctor`.
First, please run `brew update` (twice) and `brew doctor`.
Second, read the [Troubleshooting Checklist](https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Troubleshooting.md#troubleshooting).
**If you dont read these it will take us far longer to help you with your problem.**
## Contributing
Read [CONTRIBUTING.md](/.github/CONTRIBUTING.md).
Creating new formulae, updating existing ones, and fixing build issues is easier than you think!
Try `brew edit $FORMULA` and see how you fare.
## Documentation
`brew help`, `man brew`, [Homebrew/brew's README](https://github.com/Homebrew/brew#homebrew) or check [Homebrew's documentation](https://github.com/Homebrew/brew/tree/master/share/doc/homebrew#readme).