Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #13

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,14 @@
A simple utility to encode a file (or any other data) into a Go byte slice.

Having [set up your Go environment](http://golang.org/doc/install), simply run
the command below [if you are using Go under 1.17](https://go.dev/doc/go-get-install-deprecation):

go get github.com/cratonica/2goarray

Otherwise:

go install github.com/cratonica/2goarray

Then use by piping a file into the utility and capturing the output. You must provide a name for the generated slice symbol and package name. For example:

$GOPATH/bin/2goarray MyArray mypackage < myimage.png > myimage.go
Expand All @@ -26,3 +31,4 @@ This will output something like:
## Contributors
- [Clint Caywood](https://github.com/cratonica)
- [Paul Vollmer](https://github.com/paulvollmer)
- [DevDengChao](https://github.com/DevDengChao)