From 3fb2d05175bf64504b49f62e5c34add28eb9521f Mon Sep 17 00:00:00 2001 From: Andrew Miner Date: Fri, 16 Jan 2015 11:20:05 -0800 Subject: [PATCH] Updated Crafting Guide Data Format V2 (markdown) --- Crafting-Guide-Data-Format-V2.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/Crafting-Guide-Data-Format-V2.md b/Crafting-Guide-Data-Format-V2.md index df0971c..96bb964 100644 --- a/Crafting-Guide-Data-Format-V2.md +++ b/Crafting-Guide-Data-Format-V2.md @@ -39,11 +39,14 @@ item: Printed Calculation Circuit ## Basics -Each line of the file should usually contain a single command. Each command has the format: `: , , ...`. All of the available commands are described below. Multiple commands may be listed on the same line by separating them with `;` characters. +Each line of the file should usually contain a single command. Each command has the format: `: , , ...`. All of the available commands are described below. Multiple commands may be listed on the same line by separating them with `;` characters. Comments are entered using the `#` character, which can itself be escaped if you need to use it in an item name. Blank lines are ignored. -Comments are entered using the `#` character, which can itself be escaped if you need to use it in an item name. +You can check your file for errors by running the `./scripts/verify ` command on your file. This examine the file and print out any errors. If no errors are found, there is no output. While working on a data file, it is often handy to use the UNIX `watch` command to provide continuous feedback: `watch ./script/verify `. -Blank lines are ignored. +You can pretty-print a data file using the `./scripts/reformat (|-)?` command. This will +correct indentation, alphabetize items, and generally clean things up. + +Please be sure to use these two commands prior to submitting a pull request for a new data file! ## Command Reference