mirrors/brew
1
0
Fork 0
mirror of https://github.com/Homebrew/brew.git synced 2025-07-14 16:09:03 +08:00
Code Issues Packages Projects Releases Wiki Activity

Cleanup root documentation.

Browse Source
This commit is contained in:
Mike McQuaid 2014-10-26 15:23:42 +00:00
parent 19d12aee45
commit 6663e1bd6f
4 changed files with 30 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CODEOFCONDUCT.md
View File

@ -19,7 +19,7 @@ The Homebrew community welcomes and encourages participation by everyone. Our co
We have created this diversity statement because we believe that a diverse Homebrew community is stronger and more vibrant. A diverse community where people treat each other with respect has more potential contributors and more sources for ideas.
Although we have phrased the formal diversity statement generically to make it all-inclusive, we recognize that there are specific attributes that are used to discriminate against people. In alphabetical order, some of these attributes include (but are not limited to): age, culture, ethnicity, gender identity or expression, national origin, physical or mental difference, politics, race, religion, sex, sexual orientation, socio-economic status, and subculture. We welcome people regardless of the values of these or other attributes.
Although we have phrased the formal diversity statement generically to make it all-inclusive, we recognise that there are specific attributes that are used to discriminate against people. In alphabetical order, some of these attributes include (but are not limited to): age, culture, ethnicity, gender identity or expression, national origin, physical or mental difference, politics, race, religion, sex, sexual orientation, socio-economic status, and subculture. We welcome people regardless of the values of these or other attributes.
# Attribution
This code of conduct is heavily based on the [Python Community Code of Conduct](http://www.python.org/psf/codeofconduct/) and the [Python Diversity Statement](http://www.python.org/community/diversity/).

23
CONTRIBUTING.md
View File

@ -1,26 +1,21 @@
Contributing to Homebrew
========================
Reporting Bugs
--------------
# Contributing to Homebrew
## Reporting Bugs
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).
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 us far longer to help you with your problem.**
Security
--------
## Security
Please report security issues to security@brew.sh.
Contributing
------------
## Contributing
Please read:
* [Code of Conduct](https://github.com/Homebrew/homebrew/blob/master/CODEOFCONDUCT.md)
* [Formula Cookbook](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Formula-Cookbook.md)
* [Acceptable Formulae](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Acceptable-Formulae.md)
* [Code of Conduct](https://github.com/Homebrew/homebrew/blob/master/CODEOFCONDUCT.md#code-of-conduct)
* [Formula Cookbook](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Formula-Cookbook.md#formula-cookbook)
* [Acceptable Formulae](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Acceptable-Formulae.md#acceptable-formulae)
* [Ruby Style Guide](https://github.com/styleguide/ruby)
* [How To Open a Homebrew Pull Request (and get it merged)](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md)
* [How To Open a Homebrew Pull Request (and get it merged)](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md#how-to-open-a-homebrew-pull-request-and-get-it-merged)
Thanks!

61
README.md
View File

@ -1,57 +1,34 @@
Homebrew
========
Features, usage and installation instructions are [summarized on the homepage][home].
# Homebrew
Features, usage and installation instructions are [summarised on the homepage](http://brew.sh).
What Packages Are Available?
----------------------------
1. You can [browse the Formula directory on GitHub][formula].
## What Packages Are Available?
1. You can [browse the Formula directory on GitHub](https://github.com/Homebrew/homebrew/tree/master/Library/Formula/).
2. Or type `brew search` for a list.
3. Or visit [braumeister.org][braumeister] to browse packages online.
4. Or use [`brew desc`][brew-desc] to browse packages from the command line.
3. Or visit [braumeister.org](http://braumeister.org) to browse packages online.
4. Or use [`brew desc`](https://github.com/telemachus/homebrew-desc) to browse packages from the command line.
More Documentation
------------------
`brew help` or `man brew` or check our [documentation][].
## More Documentation
`brew help` or `man brew` or check our [documentation](https://github.com/Homebrew/homebrew/tree/master/share/doc/homebrew#readme).
Troubleshooting
---------------
## 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).
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 us far longer to help you with your problem.**
Security
--------
## Security
Please report security issues to security@brew.sh.
Who Are You?
------------
Homebrew's current maintainers are [Misty De Meo][mistydemeo], [Adam Vandenberg][adamv], [Jack Nagel][jacknagel], [Mike McQuaid][mikemcquaid], [Brett Koonce][asparagui] and [Tim Smith][tdsmith].
## Who Are You?
Homebrew's current maintainers are [Misty De Meo](https://github.com/mistydemeo), [Adam Vandenberg](https://github.com/adamv), [Jack Nagel](https://github.com/jacknagel), [Mike McQuaid](https://github.com/mikemcquaid), [Brett Koonce](https://github.com/asparagui) and [Tim Smith](https://github.com/tdsmith).
Homebrew was originally created by [Max Howell][mxcl].
Homebrew was originally created by [Max Howell](https://github.com/mxcl).
License
-------
Code is under the [BSD 2 Clause (NetBSD) license][license].
## License
Code is under the [BSD 2 Clause (NetBSD) license](https://github.com/Homebrew/homebrew/tree/master/LICENSE.txt).
Donations
---------
We accept tips through [Gittip][tip].
## Donations
We accept tips through [Gratipay](https://gratipay.com/Homebrew/).
[![Gittip](https://img.shields.io/gittip/Homebrew.svg?style=flat)](https://www.gittip.com/Homebrew/)
[home]:http://brew.sh
[documentation]:https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/
[mistydemeo]:https://github.com/mistydemeo
[adamv]:https://github.com/adamv
[jacknagel]:https://github.com/jacknagel
[mikemcquaid]:https://github.com/mikemcquaid
[asparagui]:https://github.com/asparagui
[tdsmith]:https://github.com/tdsmith
[mxcl]:https://github.com/mxcl
[formula]:https://github.com/Homebrew/homebrew/tree/master/Library/Formula/
[braumeister]:http://braumeister.org
[brew-desc]: https://github.com/telemachus/homebrew-desc
[license]:https://github.com/Homebrew/homebrew/tree/master/LICENSE.txt
[tip]:https://www.gittip.com/Homebrew/
[![Gratipay](https://img.shields.io/gratipay/Homebrew.svg?style=flat)](https://www.gittip.com/Homebrew/)

3
SUPPORTERS.md
View File

@ -1,5 +1,4 @@
# Kickstarter Supporters
This file contains a list of the awesome people who gave £5 or more to
[our Kickstarter](http://www.kickstarter.com/projects/homebrew/brew-test-bot).
@ -8,7 +7,7 @@ a physical reward. Kickstarter recommends asking only when we are ready to
ship (to avoid changes of address) so we can't ask for more names/URLs
until then.
These mindblowing people supported our Kickstarter by giving us £450 or more:
These mind-blowing people supported our Kickstarter by giving us £450 or more:
[![Hashrocket](https://s3.amazonaws.com/hashrocket-misc/hr_180x50.png)](http://hashrocket.com/)