rdmc 0.1.2

Run commands from you readme as if its a Makefile
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

# RDMC - Readme command

Run commands from you readme as if its a Makefile.

## Installation

```bash
cargo install rdmc
```

### Setup Autocomplete Bash

```bash
rdmc --bpaf-complete-style-bash >> ~/.bash_completion
```

# Usage

When you invoke `rdmc` it will look for a readme file at the root of your current repository. It will extract commands from it.

```bash
rdmc <Tab>
rdmc C<Tab>
rdmc Command
```

## Execute

`rdmc` will only printout the actual command. To run it you can pipe it to a shell.

```bash
rdmc <Command> | sh
```

# Readme format

`rdmc` will extract commands from all code blocks tagged with the `bash` language. The name of the command is based on its closest heading.

Reference this README file as a properly formatted example.