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

46 lines
2.0 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
man: generate Markdown man page. The existing `brew.1.html` wasn't particularly pleasant to read and given everything else in `docs/` is a Markdown file it makes sense to generate a post-processed Markdown file that can in turn be used by Jekyll to generate a nicely themed HTML file.
2017-03-22 21:37:09 +00:00
- [`brew` man-page (command documentation)](Manpage.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
- [Troubleshooting](Troubleshooting.md)
- [Installation](Installation.md)
Overhaul, simplify and cleanup documentation. Remove duplication, link to the API documentation more often, tweak wording, add `@UniqMartin` as a maintainer, note `@jacknagel`'s and `@adamv`'s significant past contributions to Homebrew, delete some outdated or unneeded documentation, add some missing `Formula` API. entries and simplify/improve `CONTRIBUTING.md`. Closes Homebrew/homebrew#46179. Closes Homebrew/homebrew#46618. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-12-06 22:18:16 +00:00
- [Frequently Asked Questions](FAQ.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
- [Common Issues](Common-Issues.md)
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
- [Tips and Tricks](Tips-N'-Tricks.md)
- [Bottles (binary packages)](Bottles.md)
docs: rename Taps docs to match convention
2017-11-17 16:40:37 -05:00
- [Taps (third-party repositories)](Taps.md)
fix link to Interesting-Taps-and-Forks.md
2017-07-11 23:36:49 -05:00
- [Interesting Taps and Forks](Interesting-Taps-and-Forks.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
- [Anonymous Aggregate User Behaviour Analytics](Analytics.md)
- [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)
- [How To Build Software Outside Homebrew With Homebrew `keg_only` dependencies](How-to-build-software-outside-Homebrew-with-Homebrew-keg-only-dependencies.md)
- [Xcode](Xcode.md)
- [Kickstarter Supporters](Kickstarter-Supporters.md)
## Contributors
- [How To Open A Pull Request (and get it merged)](How-To-Open-a-Homebrew-Pull-Request.md)
- [Formula Cookbook](Formula-Cookbook.md)
- [Acceptable Formulae](Acceptable-Formulae.md)
docs/README: link to Versions.md.
2017-01-07 13:02:09 +00:00
- [Formulae Versions](Versions.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
- [Node for Formula Authors](Node-for-Formula-Authors.md)
- [Python for Formula Authors](Python-for-Formula-Authors.md)
- [Migrating A Formula To A Tap](Migrating-A-Formula-To-A-Tap.md)
- [Rename A Formula](Rename-A-Formula.md)
- [How To Create (And Maintain) A Tap](How-to-Create-and-Maintain-a-Tap.md)
- [Brew Test Bot](Brew-Test-Bot.md)
- [Prose Style Guidelines](Prose-Style-Guidelines.md)
## Maintainers
- [New Maintainer Checklist](New-Maintainer-Checklist.md)
docs: grammar edits, sentence-case secondary headings Also changes some heading levels so only one primary heading appears per page.
2017-03-18 17:45:12 -04:00
- [Maintainers: Avoiding Burnout](Maintainers-Avoiding-Burnout.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
- [Maintainer Guidelines](Maintainer-Guidelines.md)
- [Brew Test Bot For Maintainers](Brew-Test-Bot-For-Core-Contributors.md)
- [Common Issues for Maintainers](Common-Issues-for-Core-Contributors.md)
Reference in New Issue Copy Permalink