Further documentation updates.

This commit is contained in:
Spencer Brower
2018-06-24 16:38:52 -04:00
parent 206b94dcac
commit a0d6686cbc
5 changed files with 23 additions and 6 deletions

View File

@@ -4,8 +4,7 @@
Package ps is a rudimentary API between Adobe Photoshop CS5 and Golang. The Package ps is a rudimentary API between Adobe Photoshop CS5 and Golang. The
interaction between the two is implemented using Javascript/VBScript. interaction between the two is implemented using Javascript/VBScript.
Currently only supports Photoshop CS5 Windows x86_64. go:generate godocdown Currently only supports Photoshop CS5 Windows x86_64.
-output=README.md
## Installation ## Installation
```bash ```bash

3
ps.go
View File

@@ -1,8 +1,9 @@
//go:generate godocdown -output=README.md
// Package ps is a rudimentary API between Adobe Photoshop CS5 and Golang. // Package ps is a rudimentary API between Adobe Photoshop CS5 and Golang.
// The interaction between the two is implemented using Javascript/VBScript. // The interaction between the two is implemented using Javascript/VBScript.
// //
// Currently only supports Photoshop CS5 Windows x86_64. // Currently only supports Photoshop CS5 Windows x86_64.
//go:generate godocdown -output=README.md
package ps package ps
import ( import (

View File

@@ -54,7 +54,7 @@ func TestClose(t *testing.T) {
if testing.Short() { if testing.Short() {
t.Skip("Skipping \"TestClose\"") t.Skip("Skipping \"TestClose\"")
} }
err := Close(2) err := Close(DoNotSaveChanges)
if err != nil { if err != nil {
t.Fatal(err) t.Fatal(err)
} }
@@ -65,7 +65,7 @@ func TestQuit(t *testing.T) {
t.Skip("Skipping \"TestQuit\"") t.Skip("Skipping \"TestQuit\"")
} }
Init() Init()
err := Quit(2) err := Quit(DoNotSaveChanges)
if err != nil { if err != nil {
t.Fatal(err) t.Fatal(err)
} }
@@ -95,7 +95,7 @@ func TestRun(t *testing.T) {
t.Fatal(err) t.Fatal(err)
} }
if string(msg) != string(out) { if string(msg) != string(out) {
fail := fmt.Sprintf("TestRun faild.\ngot:\n\"%s\"\nwant:\n\"%s\"\n", msg, out) fail := fmt.Sprintf("TestRun failed.\ngot:\n\"%s\"\nwant:\n\"%s\"\n", msg, out)
t.Fatal(fail) t.Fatal(fail)
} }
} }

11
runner/README.md Normal file
View File

@@ -0,0 +1,11 @@
# 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)
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.
## Installation
```bash
$ go get -u github.com/sbrow/ps/runner
```

View File

@@ -1,3 +1,9 @@
//go:generate godocdown -template ../.godocdown.template -output=README.md
// 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.
package runner package runner
import ( import (