Skip to content

Commit

Permalink
Merge pull request #12 from myitcv/mdreplace_self_document
Browse files Browse the repository at this point in the history
cmd/mdreplace: self-document usage in README
  • Loading branch information
myitcv authored Apr 10, 2018
2 parents 9d9cad1 + a08f2c1 commit 9879d50
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 6 deletions.
13 changes: 7 additions & 6 deletions _scripts/run_tests.sh
Original file line number Diff line number Diff line change
Expand Up @@ -37,16 +37,17 @@ then
export GOPROXY="file://$PWD"

popd > /dev/null

$go version
$go env

# can potentially go when we get a resolution on
# https://github.com/golang/go/issues/24748
echo "GOPROXY=\"${GOPROXY:-}\""
fi

export PATH=$GOPATH/bin:$PATH

$go version
$go env

# can potentially go when we get a resolution on
# https://github.com/golang/go/issues/24748
echo "GOPROXY=\"${GOPROXY:-}\""

# get all packages that do not belong to a module that has its
# own _scripts/run_tests.sh file
Expand Down
23 changes: 23 additions & 0 deletions cmd/mdreplace/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,29 @@ hello world today
_To see this in action, look at the [source of the
`README.md`](https://raw.githubusercontent.com/myitcv/x/master/cmd/mdreplace/README.md) you are currently reading._

### Usage

<!-- __TEMPLATE: mdreplace -h
```
{{.}}
```
-->
```
Usage:
mdreplace file1 file2 ...
mdreplace
When called with no file arguments, mdreplace works with stdin
Flags:
-h show usage information
-strip
whether to strip special comments from the file
-w whether to write back to input files (cannot be used when reading from stdin)
```
<!-- END -->

### Code fences

Expand Down

0 comments on commit 9879d50

Please sign in to comment.