admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity
brew/docs/README.md

80 lines
3.4 KiB
Markdown
Raw Normal View History

Cleanup documentation site GitHub now nicely generates a documentation site for us at http://brew.sh/brew based on our docs folder. Optimise the output of this and the GitHub docs directory for readability and the various user groupings.
2017-01-04 10:53:21 +00:00
# Documentation
Import docs from wiki. Closes Homebrew/homebrew#33211.
2014-10-26 14:54:36 +00:00
Cleanup documentation site GitHub now nicely generates a documentation site for us at http://brew.sh/brew based on our docs folder. Optimise the output of this and the GitHub docs directory for readability and the various user groupings.
2017-01-04 10:53:21 +00:00
## Users
Update maintainer documentation. - Fix Markdown format - Note Linux in the mission statement - Update the maintainer guidelines based on current state - Loosen the new maintainer expectations - Clarify what things the PLC should be added to - Add documentation for making a new Homebrew release
2019-02-13 15:02:18 +00:00
docs: hyperlink updates plus some reformatting
2022-12-03 16:44:33 -05:00
- [`brew` manual page (command documentation)](Manpage.md)
README.md: Add link to Homebrew blog Inspired by https://github.com/Homebrew/brew/issues/8096 and https://github.com/Homebrew/brew/pull/8098. I think the blog is an important way for regular users to keep up-to-date with Homebrew evolution, so it deserves an entry in the main docs page. Update docs/README.md Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
2020-07-27 15:23:21 +08:00
- [Homebrew Blog (news on major updates)](https://brew.sh/blog/)
Revert "docs: use short links." This reverts commit e63a2ee8de12f0f938f6a95cdb9763dbe0187b4a. Closes #3832.
2018-02-23 19:39:19 +00:00
- [Installation](Installation.md)
docs: hyperlink updates plus some reformatting
2022-12-03 16:44:33 -05:00
- [Troubleshooting](Troubleshooting.md)
- [FAQ (Frequently Asked Questions)](FAQ.md)
Revert "docs: use short links." This reverts commit e63a2ee8de12f0f938f6a95cdb9763dbe0187b4a. Closes #3832.
2018-02-23 19:39:19 +00:00
- [Common Issues](Common-Issues.md)
Doco: add a Shell Completion doc This describes how to configure your shell to use Homebrew-managed completion definitions. Needed because this is a manual step the user has to do.
2018-05-22 04:49:32 -04:00
- [`brew` Shell Completion](Shell-Completion.md)
Update Linuxbrew references to Homebrew on Linux This is a clearer branding for us to use. Also, as part of testing this, make some fixes to Jekyll in the docs folder. Fixes #5835
2019-03-12 20:13:38 +00:00
- [Homebrew on Linux](Homebrew-on-Linux.md)
Import docs from wiki. Closes Homebrew/homebrew#33211.
2014-10-26 14:54:36 +00:00
Revert "docs: use short links." This reverts commit e63a2ee8de12f0f938f6a95cdb9763dbe0187b4a. Closes #3832.
2018-02-23 19:39:19 +00:00
- [Bottles (binary packages)](Bottles.md)
- [Taps (third-party repositories)](Taps.md)
- [Interesting Taps and Forks](Interesting-Taps-and-Forks.md)
docs: hyperlink updates plus some reformatting
2022-12-03 16:44:33 -05:00
- [Tips and Tricks](Tips-N'-Tricks.md)
Remove Google Analytics We are now entirely migrated to InfluxDB so can remove all GA code.
2023-06-16 10:33:15 +01:00
- [Anonymous Analytics](Analytics.md)
Cleanup documentation site GitHub now nicely generates a documentation site for us at http://brew.sh/brew based on our docs folder. Optimise the output of this and the GitHub docs directory for readability and the various user groupings.
2017-01-04 10:53:21 +00:00
Revert "docs: use short links." This reverts commit e63a2ee8de12f0f938f6a95cdb9763dbe0187b4a. Closes #3832.
2018-02-23 19:39:19 +00:00
- [Querying `brew`](Querying-Brew.md)
- [C++ Standard Libraries](C++-Standard-Libraries.md)
- [MD5 and SHA-1 Deprecation](Checksum_Deprecation.md)
- [Custom GCC and Cross Compilers](Custom-GCC-and-cross-compilers.md)
- [External Commands](External-Commands.md)
- [Ruby Gems, Python Eggs and Perl Modules](Gems,-Eggs-and-Perl-Modules.md)
- [Python](Homebrew-and-Python.md)
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
- [How to Build Software Outside Homebrew with Homebrew `keg_only` Dependencies](How-to-Build-Software-Outside-Homebrew-with-Homebrew-keg-only-Dependencies.md)
Revert "docs: use short links." This reverts commit e63a2ee8de12f0f938f6a95cdb9763dbe0187b4a. Closes #3832.
2018-02-23 19:39:19 +00:00
- [Xcode](Xcode.md)
Cleanup documentation site GitHub now nicely generates a documentation site for us at http://brew.sh/brew based on our docs folder. Optimise the output of this and the GitHub docs directory for readability and the various user groupings.
2017-01-04 10:53:21 +00:00
Docs: Add guides for common cases Co-authored-by: Sam Ford <1584702+samford@users.noreply.github.com>
2020-02-03 22:25:20 +01:00
- [Creating a Homebrew Issue](Creating-a-Homebrew-Issue.md)
- [Updating Software in Homebrew](Updating-Software-in-Homebrew.md)
- [Adding Software to Homebrew](Adding-Software-to-Homebrew.md)
docs: move supporters into its own group
2020-09-08 23:12:13 +10:00
- [Kickstarter Supporters](Kickstarter-Supporters.md)
Cleanup documentation site GitHub now nicely generates a documentation site for us at http://brew.sh/brew based on our docs folder. Optimise the output of this and the GitHub docs directory for readability and the various user groupings.
2017-01-04 10:53:21 +00:00
## Contributors
Update maintainer documentation. - Fix Markdown format - Note Linux in the mission statement - Update the maintainer guidelines based on current state - Loosen the new maintainer expectations - Clarify what things the PLC should be added to - Add documentation for making a new Homebrew release
2019-02-13 15:02:18 +00:00
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
- [How to Open a Pull Request (and get it merged)](How-To-Open-a-Homebrew-Pull-Request.md)
Revert "docs: use short links." This reverts commit e63a2ee8de12f0f938f6a95cdb9763dbe0187b4a. Closes #3832.
2018-02-23 19:39:19 +00:00
- [Formula Cookbook](Formula-Cookbook.md)
docs: add Cask Cookbook
2021-04-26 10:25:58 +02:00
- [Cask Cookbook](Cask-Cookbook.md)
Revert "docs: use short links." This reverts commit e63a2ee8de12f0f938f6a95cdb9763dbe0187b4a. Closes #3832.
2018-02-23 19:39:19 +00:00
- [Acceptable Formulae](Acceptable-Formulae.md)
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
- [Acceptable Casks](Acceptable-Casks.md)
docs: update license documentation
2020-08-24 01:54:28 -04:00
- [License Guidelines](License-Guidelines.md)
Revert "docs: use short links." This reverts commit e63a2ee8de12f0f938f6a95cdb9763dbe0187b4a. Closes #3832.
2018-02-23 19:39:19 +00:00
- [Formulae Versions](Versions.md)
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
- [Deprecating, Disabling and Removing Formulae](Deprecating-Disabling-and-Removing-Formulae.md)
Revert "docs: use short links." This reverts commit e63a2ee8de12f0f938f6a95cdb9763dbe0187b4a. Closes #3832.
2018-02-23 19:39:19 +00:00
- [Node for Formula Authors](Node-for-Formula-Authors.md)
- [Python for Formula Authors](Python-for-Formula-Authors.md)
Address feedback and expand documentation Co-authored-by: Mike McQuaid <mike@mikemcquaid.com> Co-authored-by: Sean Molenaar <1484494+SMillerDev@users.noreply.github.com>
2021-01-11 17:12:48 -05:00
- [`brew livecheck`](Brew-Livecheck.md)
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
- [Migrating a Formula to a Tap](Migrating-A-Formula-To-A-Tap.md)
- [Renaming a Formula](Rename-A-Formula.md)
Revert "docs: use short links." This reverts commit e63a2ee8de12f0f938f6a95cdb9763dbe0187b4a. Closes #3832.
2018-02-23 19:39:19 +00:00
- [Building Against Non-Homebrew Dependencies](Building-Against-Non-Homebrew-Dependencies.md)
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
- [How to Create and Maintain a Tap](How-to-Create-and-Maintain-a-Tap.md)
Revert "docs: use short links." This reverts commit e63a2ee8de12f0f938f6a95cdb9763dbe0187b4a. Closes #3832.
2018-02-23 19:39:19 +00:00
- [Brew Test Bot](Brew-Test-Bot.md)
Add flowchart for managing pull requests - Add flowchart for handling ready-to-merge pull requests - Add diagram guidelines Many thanks to Sean Molenaar for the idea and initial version of the chart. CC: Sean Molenaar <smillernl@me.com>
2020-09-06 00:35:26 +02:00
- [Diagram Guidelines](Diagram-Guidelines.md)
Revert "docs: use short links." This reverts commit e63a2ee8de12f0f938f6a95cdb9763dbe0187b4a. Closes #3832.
2018-02-23 19:39:19 +00:00
- [Prose Style Guidelines](Prose-Style-Guidelines.md)
docs: add sorbet documentation (cherry picked from commit 022571489a0f94ed54a0908167b553592cfe3277)
2020-08-18 19:21:29 +05:30
- [Type Checking with Sorbet](Typechecking.md)
docs: add documentation about reproducible builds
2023-07-13 12:25:33 -04:00
- [Reproducible Builds](Reproducible-Builds.md)
Cleanup documentation site GitHub now nicely generates a documentation site for us at http://brew.sh/brew based on our docs folder. Optimise the output of this and the GitHub docs directory for readability and the various user groupings.
2017-01-04 10:53:21 +00:00
docs/README: improve rubydoc.brew.sh link This shouldn't really be maintainers only. Fixes https://github.com/Homebrew/brew/issues/15026
2023-03-21 17:50:49 +00:00
- [Ruby API Documentation](https://rubydoc.brew.sh) (e.g. for `Formula` etc.)
Cleanup documentation site GitHub now nicely generates a documentation site for us at http://brew.sh/brew based on our docs folder. Optimise the output of this and the GitHub docs directory for readability and the various user groupings.
2017-01-04 10:53:21 +00:00
## Maintainers
Update maintainer documentation. - Fix Markdown format - Note Linux in the mission statement - Update the maintainer guidelines based on current state - Loosen the new maintainer expectations - Clarify what things the PLC should be added to - Add documentation for making a new Homebrew release
2019-02-13 15:02:18 +00:00
Revert "docs: use short links." This reverts commit e63a2ee8de12f0f938f6a95cdb9763dbe0187b4a. Closes #3832.
2018-02-23 19:39:19 +00:00
- [New Maintainer Checklist](New-Maintainer-Checklist.md)
- [Maintainers: Avoiding Burnout](Maintainers-Avoiding-Burnout.md)
docs: reorganize maintainer guides
2021-05-12 20:59:09 -04:00
Revert "docs: use short links." This reverts commit e63a2ee8de12f0f938f6a95cdb9763dbe0187b4a. Closes #3832.
2018-02-23 19:39:19 +00:00
- [Maintainer Guidelines](Maintainer-Guidelines.md)
docs: update based on suggestions from code review Co-Authored-By: Eric Knibbe <3324775+EricFromCanada@users.noreply.github.com>
2021-05-14 13:49:16 -04:00
- [Homebrew/brew Maintainer Guide](Homebrew-brew-Maintainer-Guide.md)
docs: rename core maintainer guide for consistency
2021-05-19 12:52:28 -04:00
- [Homebrew/homebrew-core Maintainer Guide](Homebrew-homebrew-core-Maintainer-Guide.md)
docs: update based on suggestions from code review Co-Authored-By: Eric Knibbe <3324775+EricFromCanada@users.noreply.github.com>
2021-05-14 13:49:16 -04:00
- [Homebrew/homebrew-cask Maintainer Guide](Homebrew-homebrew-cask-Maintainer-Guide.md)
docs: reorganize maintainer guides
2021-05-12 20:59:09 -04:00
docs: hyperlink updates plus some reformatting
2022-12-03 16:44:33 -05:00
- [Brew Test Bot for Maintainers](Brew-Test-Bot-For-Core-Contributors.md)
Revert "docs: use short links." This reverts commit e63a2ee8de12f0f938f6a95cdb9763dbe0187b4a. Closes #3832.
2018-02-23 19:39:19 +00:00
- [Common Issues for Maintainers](Common-Issues-for-Core-Contributors.md)
Update maintainer documentation. - Fix Markdown format - Note Linux in the mission statement - Update the maintainer guidelines based on current state - Loosen the new maintainer expectations - Clarify what things the PLC should be added to - Add documentation for making a new Homebrew release
2019-02-13 15:02:18 +00:00
- [Releases](Releases.md)
Add/link Homebrew Governance document.
2019-02-15 10:54:30 +00:00
## Governance
- [Homebrew Governance](Homebrew-Governance.md)
Update Homebrew's governance documentation. This is imported from the private repository agreed upon by the PL, PLC and TSC.
2022-03-31 12:08:12 +01:00
- [Homebrew Leadership Responsibilities](Homebrew-Leadership-Responsibilities.md)
docs: add automatic listing of governance archives
2022-04-23 17:01:26 -04:00
- [Homebrew Governance Archives](Homebrew-Governance-Archives.md)
Reference in New Issue Copy Permalink