typewriter turns your README into a github page.
Shell
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
AUTHORS
LICENSE
README.rst
typewriter

README.rst

typewriter

typewriter turns your README into a github page.

http://project-logos.lvh.cc/typewriter.png

Usage

Run typewriter from a clean git repository. Pass it a template (a git repository) with the -t flag:

typewriter -t [template]

The repository specification is parsed using git, or hub if it's available.

Themes

Themes are git repositories. They're cloned into a temporary directory and built using a Makefile. The gh-pages branch is checked out in the current repository. The working tree is cleaned up, assuming it was built by typewriter before (which is checked by the presence of .typewriter). The built theme is copied and committed in, and the result is pushed back to Github.

A theme has a src/ folder. The README file is copied into that folder. typewriter then runs make build, and expects the contents in the build/ folder.

Take a look at ttlvh for an example of a theme. It's the one used to render the github page for typewriter itself, amongst other things.