Skip to content

Commit

Permalink
readme: Minor update of readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
mewmew committed Feb 3, 2015
1 parent be9b348 commit 0a33ef5
Showing 1 changed file with 4 additions and 12 deletions.
16 changes: 4 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,7 @@ Documentation provided by GoDoc.

go get github.com/mewmew/blend

To parse more complex blend files "block/struct.go" and "block/parse.go" may
need to be regenereted. To regenerate these two files for any given blend file,
use the `blendef` tool.
To parse more complex blend files "block/struct.go" and "block/parse.go" may need to be regenereted. To regenerate these two files for any given blend file, use the `blendef` tool.

go get github.com/mewmew/blend/cmd/blendef
cd $GOPATH/src/github.com/mewmew/blend/block
Expand Down Expand Up @@ -52,21 +50,15 @@ A more detailed description is given in the "self-describing format" section.

## Self-describing format

One unique feature of blend files is that they contain a full definition of
every structure used in its file blocks. The structure definitions are stored in
the DNA block.
One unique feature of blend files is that they contain a full definition of every structure used in its file blocks. The structure definitions are stored in the DNA block.

All block structure definitions ("block/struct.go") and the block parsing logic
("block/parse.go") have been generating by parsing the DNA block of
"testdata/block.blend".
All block structure definitions ("block/struct.go") and the block parsing logic ("block/parse.go") have been generating by parsing the DNA block of "testdata/block.blend".

The tool which was used to generate these two files is located at:

github.com/mewmew/blend/cmd/blendef

More complex blend files may contain structures which are not yet defined in the
block package. If so, use `blendef` to regenerate "struct.go" and "parse.go" for
the given blend file.
More complex blend files may contain structures which are not yet defined in the block package. If so, use `blendef` to regenerate "struct.go" and "parse.go" for the given blend file.

## Public domain

Expand Down

0 comments on commit 0a33ef5

Please sign in to comment.