go
/
bindata
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Revises README to reflect changes to command line API.

pull/4/head
Jim Teeuwen 2013-11-16 12:20:14 +01:00
parent 4674192d6b
commit b903585359
1 changed files with 14 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -11,7 +11,7 @@ output being generated.
### Usage
Conversion is done on a set of files. They are all embedded in a new
Conversion is done on one or more sets of files. They are all embedded in a new
Go source file, along with a table of contents and an `Asset` function,
which allows quick access to the asset, based on its name.
@ -20,20 +20,25 @@ working directory. It includes all assets from the `data` directory.
$ go-bindata data/
To include all input sub-directories recursively, add the `-r` flag,
otherwise it will only consider files in the input directory itself.
To include all input sub-directories recursively, use the elipsis postfix
as defined for Go import paths. Otherwise it will only consider assets in the
input directory itself.
$ go-bindata -r data/
$ go-bindata data/...
To specify the name of the output file being generated, we use the following:
$ go-bindata data/ myfile.go
$ go-bindata -o myfile.go data/
Multiple input directories can be specified if necessary.
$ go-bindata dir1/... /path/to/dir3/... dir3
The following paragraphs detail some of the command line options which can
supplied to `go-bindata`.
Refer to the `testdata/out` directory for various output examples from
the assets in `testdata/in`. Each example uses different command line options.
supplied to `go-bindata`. Refer to the `testdata/out` directory for various
output examples from the assets in `testdata/in`. Each example uses different
command line options.
### Debug vs Release builds