Skip to content

Commit

Permalink
docs + scaffolding
Browse files Browse the repository at this point in the history
  • Loading branch information
wayneashleyberry committed Apr 9, 2019
1 parent 9120d58 commit ca33664
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 3 deletions.
17 changes: 17 additions & 0 deletions cmd/convert/convert.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
package convert

import "github.com/spf13/cobra"

// Command will create a new convert command
func Command() *cobra.Command {
cmd := &cobra.Command{
Use: "convert [source.png] target.cube",
Short: "Convert a LUT file to a different format",
Args: cobra.ExactArgs(2),
Run: func(cmd *cobra.Command, args []string) {
//
},
}

return cmd
}
6 changes: 5 additions & 1 deletion main.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"os"

"github.com/overhq/lut/cmd/apply"
"github.com/overhq/lut/cmd/convert"
"github.com/spf13/cobra"
)

Expand All @@ -19,7 +20,10 @@ func main() {
},
}

cmd.AddCommand(apply.Command())
cmd.AddCommand(
apply.Command(),
convert.Command(),
)

cmd.AddCommand(&cobra.Command{
Use: "version",
Expand Down
15 changes: 13 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,17 @@ This command-line tool and packages were written to inspect LUT's locally, and p

There are tons of free LUT's available online, [LUTHOUSE](https://www.luthouse.com/free-luts) has some of my favourite.

### Quickstart

> :warning: You will need a `HOMEBREW_GITHUB_API_TOKEN` environment variable set to get access to our private homebrew tap.
```sh
brew tap overhq/homebrew-tap
brew install overhq/tap/lut
```

[Binaries are available for you to download](https://github.com/overhq/lut/releases/latest) if you don't want to [write Go code](https://golang.org/doc/code.html).

### Usage

```
Expand All @@ -17,16 +28,16 @@ Usage:
Available Commands:
apply Adjust image colour according to a LUT
convert Convert a LUT file to a different format
help Help about any command
version Print version information
Flags:
-h, --help help for lut
Use "lut [command] --help" for more information about a command.
```

[Binaries are available for you to download](https://github.com/overhq/lut/releases/latest) if you don't want to [write Go code](https://golang.org/doc/code.html).

### Installation

This project uses [Go modules](https://blog.golang.org/modules2019), so make sure to clone it outside of your `$GOPATH`. You will need at least Go 1.11.
Expand Down

0 comments on commit ca33664

Please sign in to comment.