rundown

README

Rundown

Rundown is both a CLI tool and a set of invisible markup extensions for Markdown, allowing you to create command-line interfaces to execute your documentation's code blocks. Rundown's philosophy is that readable and executable documentation is equally important.

To install rundown:

brew install elseano/taps/rundown

There are also deb, rpm and apk files included in the releases to install on Linux systems.

Some of the usecases rundown suits are:

• Task runners
• Automated setup guides
• Tutorials
• Code building scripts
• Simple programs
• Operational support scripts

Getting Started

Rundown expects to find a RUNDOWN.md file in the current or parent directory.

Read the Full documentation, or checkout the examples linked below.

A simple Rundown file:

# Handy Scripts

<r help>

These are a collection of handy scripts we use when developing our application.

To get started, you'll probably want the `compile` command.

</r>

## Compile the application <r section="compile" />

<r help>

Builds the final application binary as `coolbro`.

</r>

<r spinner="Compiling application...">To compile the application, run this command:</r>

``` bash
go build
```

Using rundown, you can see all the commands supported:

$ rundown --help
Rundown turns Markdown files into console scripts.

  These are a collection of handy scripts we use when developing our application.
  
  To get started, you'll probably want the compile command.

Usage:
  rundown [command] [flags]...
  rundown [command]

Available Commands:
  compile     Compile the application
  help        Help about any command

Or get help for a specific command:

$ rundown compile --help
Compile the application

  Builds the final application binary as coolbro.

Usage:
  rundown compile [flags]

Flags:
  -h, --help   help for compile

Rundown supports adding help and flags to your commands, as well as a number of more advanced features.