-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated documentation
- Loading branch information
Unknown
committed
Jul 5, 2018
1 parent
a0d6686
commit 4294932
Showing
11 changed files
with
264 additions
and
81 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
{{with .PDoc}}{{if $.IsMain}}> {{ base .ImportPath }} | ||
{{comment_md .Doc}}{{else}}# {{ .Name }} | ||
[![GoDoc](https://godoc.org/{{ .ImportPath }}?status.svg)](https://godoc.org/github.com/sbrow/{{ .Name }}) [![Build Status](https://travis-ci.org/sbrow/{{ .Name }}.svg?branch=master)](https://travis-ci.org/sbrow/{{ .Name }}) [![Coverage Status](https://coveralls.io/repos/github/sbrow/{{ .Name }}/badge.svg?branch=master)](https://coveralls.io/github/sbrow/{{ .Name }}?branch=master) [![Go Report Card](https://goreportcard.com/badge/{{ .ImportPath }})](https://goreportcard.com/report/{{ .ImportPath }}) | ||
|
||
`import "{{.ImportPath}}"` | ||
|
||
* [Overview](#pkg-overview) | ||
* [Installation](pkg-installation){{if $.Dirs}} | ||
* [Subdirectories](#pkg-subdirectories){{end}}{{ with .Notes}}{{ range $marker, $content := .}} | ||
* [{{$marker}}](#pkg-note-{{$marker}}){{end}} | ||
{{- end}} | ||
* [Documentation](#pkg-doc) | ||
|
||
## <a name="pkg-overview">Overview</a> | ||
{{comment_md .Doc}} | ||
{{example_html $ ""}} | ||
|
||
|
||
## <a name="pkg-installation">Installation</a> | ||
```sh | ||
$ go get -u {{ .ImportPath }} | ||
``` | ||
<!--- | ||
{{if $.Examples}} | ||
#### <a name="pkg-examples">Examples</a>{{- range $.Examples}} | ||
* [{{example_name .Name}}](example_{{.Name}}_test.go){{- end}}{{- end}} | ||
{{end}} | ||
---> | ||
|
||
{{ with .Notes}} | ||
{{ range $marker, $content := .}} | ||
## <a name="pkg-note-{{$marker}}">{{$marker}}</a> | ||
{{ range $key, $value := .}} | ||
`{{ $value.UID }}:` {{ $value.Body }}{{end}}{{end}}{{end}} | ||
## <a name="pkg-doc">Documentation</a> | ||
For full Documentation please visit https://godoc.org/{{.ImportPath}} | ||
- - - | ||
{{end}} | ||
|
||
Generated by [godoc2md](http://godoc.org/github.com/davecheney/godoc2md) |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,54 @@ | ||
# ps | ||
[![GoDoc](https://godoc.org/github.com/sbrow/ps?status.svg)](https://godoc.org/github.com/sbrow/ps) [![Build Status](https://travis-ci.org/sbrow/ps.svg?branch=master)](https://travis-ci.org/sbrow/ps) [![Coverage Status](https://coveralls.io/repos/github/sbrow/ps/badge.svg?branch=master)](https://coveralls.io/github/sbrow/ps?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/sbrow/ps)](https://goreportcard.com/report/github.com/sbrow/ps) | ||
|
||
Package ps is a rudimentary API between Adobe Photoshop CS5 and Golang. The | ||
interaction between the two is implemented using Javascript/VBScript. | ||
`import "github.com/sbrow/ps"` | ||
|
||
* [Overview](#pkg-overview) | ||
* [Installation](pkg-installation) | ||
* [Subdirectories](#pkg-subdirectories) | ||
* [TODO](#pkg-note-TODO) | ||
* [Documentation](#pkg-doc) | ||
|
||
## <a name="pkg-overview">Overview</a> | ||
Package ps is a rudimentary API between Adobe Photoshop CS5 and Golang. | ||
The interaction between the two is implemented using Javascript/VBScript. | ||
|
||
Use it to control Photoshop, edit documents, and perform batch operations. | ||
|
||
Currently only supports Photoshop CS5 Windows x86_64. | ||
|
||
## Installation | ||
```bash | ||
|
||
|
||
|
||
|
||
## <a name="pkg-installation">Installation</a> | ||
```sh | ||
$ go get -u github.com/sbrow/ps | ||
``` | ||
<!--- | ||
#### <a name="pkg-examples">Examples</a> | ||
* [JSLayer](example_JSLayer_test.go) | ||
---> | ||
|
||
|
||
|
||
## <a name="pkg-note-TODO">TODO</a> | ||
|
||
`sbrow:` (2) Make TextLayer a subclass of ArtLayer. | ||
|
||
`sbrow:` Reduce cylcomatic complexity | ||
|
||
`sbrow:` Does funky things when passed invalid layername. | ||
|
||
`sbrow:` Move to Document | ||
|
||
`sbrow:` get rid of the semicolon. | ||
|
||
## <a name="pkg-doc">Documentation</a> | ||
For full Documentation please visit https://godoc.org/github.com/sbrow/ps | ||
- - - | ||
|
||
|
||
Generated by [godoc2md](http://godoc.org/github.com/davecheney/godoc2md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
package ps | ||
|
||
// Group represents a Document or LayerSet. | ||
type Group interface { | ||
Name() string | ||
Parent() Group | ||
SetParent(Group) | ||
Path() string | ||
ArtLayer(name string) *ArtLayer | ||
LayerSet(name string) *LayerSet | ||
ArtLayers() []*ArtLayer | ||
LayerSets() []*LayerSet | ||
MustExist(name string) Layer | ||
MarshalJSON() ([]byte, error) | ||
UnmarshalJSON(b []byte) error | ||
} | ||
|
||
// Layer represents an ArtLayer or LayerSet Object. | ||
type Layer interface { | ||
Bounds() [2][2]int | ||
MarshalJSON() ([]byte, error) | ||
Name() string | ||
Parent() Group | ||
Path() string | ||
Refresh() error | ||
SetParent(g Group) | ||
SetPos(x, y int, bound string) | ||
SetVisible(b bool) error | ||
UnmarshalJSON(b []byte) error | ||
Visible() bool | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.