Updated Crafting Guide Data Format V2 (markdown)

This commit is contained in:
Andrew Miner
2015-01-16 11:20:05 -08:00
parent 37a1711446
commit 3fb2d05175
+6 -3
View File
@@ -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: `<command>: <arg>, <arg>, ...`. 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: `<command>: <arg>, <arg>, ...`. 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 <file>` 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 <file>`.
Blank lines are ignored.
You can pretty-print a data file using the `./scripts/reformat <file> (<output>|-)?` 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