GitHub supports several lightweight markup languages for documentation; the most popular ones (generally, not just at GitHub) are Markdown and reStructuredText. Markdown is sometimes considered easier to use, and is often preferred when the purpose is simply to generate HTML. On the other hand, reStructuredText is more extensible and powerful, with native support (not just embedded HTML) for tables, as well as things like automatic generation of tables of contents.
Note on Oct 4, 2018: due to a change in Homebrew's brew test-bot
behaviour, the user must set HOMEBREW_TRAVIS_CI
and HOMEBREW_TRAVIS_SUDO
appropriately (it was previously using Travis-CI-provided TRAVIS
and TRAVIS_SUDO
).
This tutorial is a follow-up to the discussion we had on davidchall/homebrew-hep#114.
It relies on a fork of the test-bot
provided by davidchall; you can get it with brew tap maelvalais/test-bot
.
First:
- the Github project must be of the form
https://github.com//homebrew-
with the following tree
FWIW: I (@rondy) am not the creator of the content shared here, which is an excerpt from Edmond Lau's book. I simply copied and pasted it from another location and saved it as a personal note, before it gained popularity on news.ycombinator.com. Unfortunately, I cannot recall the exact origin of the original source, nor was I able to find the author's name, so I am can't provide the appropriate credits.
- By Edmond Lau
- Highly Recommended 👍
- http://www.theeffectiveengineer.com/