Changed readme template

Updated documentation
This commit is contained in:
Unknown
2018-07-05 16:07:10 -04:00
parent a0d6686cbc
commit 4294932b1f
11 changed files with 264 additions and 81 deletions

View File

@@ -1,11 +1,35 @@
# runner
[![GoDoc](https://godoc.org/github.com/sbrow/runner?status.svg)](https://godoc.org/github.com/sbrow/runner) [![Build Status](https://travis-ci.org/sbrow/runner.svg?branch=master)](https://travis-ci.org/sbrow/runner) [![Coverage Status](https://coveralls.io/repos/github/sbrow/runner/badge.svg?branch=master)](https://coveralls.io/github/sbrow/runner?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/sbrow/runner)](https://goreportcard.com/report/github.com/sbrow/runner)
[![GoDoc](https://godoc.org/github.com/sbrow/ps/runner?status.svg)](https://godoc.org/github.com/sbrow/runner) [![Build Status](https://travis-ci.org/sbrow/runner.svg?branch=master)](https://travis-ci.org/sbrow/runner) [![Coverage Status](https://coveralls.io/repos/github/sbrow/runner/badge.svg?branch=master)](https://coveralls.io/github/sbrow/runner?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/sbrow/ps/runner)](https://goreportcard.com/report/github.com/sbrow/ps/runner)
Package runner runs the non-go code that Photoshop understands, and passes it to
back to the go program. Currently, this is primarily implemented through Adobe
Extendscript, but hopefully in the future it will be upgraded to a C++ plugin.
`import "github.com/sbrow/ps/runner"`
## Installation
```bash
* [Overview](#pkg-overview)
* [Installation](pkg-installation)
* [Documentation](#pkg-doc)
## <a name="pkg-overview">Overview</a>
Package runner runs the non-go code that Photoshop understands,
and passes it to back to the go program. Currently, this is
primarily implemented through Adobe Extendscript, but hopefully
in the future it will be upgraded to a C++ plugin.
## <a name="pkg-installation">Installation</a>
```sh
$ go get -u github.com/sbrow/ps/runner
```
<!---
--->
## <a name="pkg-doc">Documentation</a>
For full Documentation please visit https://godoc.org/github.com/sbrow/ps/runner
- - -
Generated by [godoc2md](http://godoc.org/github.com/davecheney/godoc2md)

View File

@@ -1,4 +1,4 @@
//go:generate godocdown -template ../.godocdown.template -output=README.md
//go:generate sh -c "godoc2md -template ../.doc.template github.com/sbrow/ps/runner > README.md"
// Package runner runs the non-go code that Photoshop understands,
// and passes it to back to the go program. Currently, this is
@@ -16,7 +16,8 @@ import (
"strings"
)
// Windows is the runner for Visual Basic Scripts.
// Windows is the runner Windows Operating Systems.
// It runs Visual Basic Scripts.
var Windows = Runner{
Cmd: "cscript.exe",
Args: []string{"/nologo"},