diff options
Diffstat (limited to 'test/bin/readme.md')
| -rw-r--r-- | test/bin/readme.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/test/bin/readme.md b/test/bin/readme.md new file mode 100644 index 0000000..2c80382 --- /dev/null +++ b/test/bin/readme.md @@ -0,0 +1,19 @@ +# binary tests + +this folder contains binary source (.bs) files, that can be converted to .bin +files using the provided makefile. these files can contain comments, and are +processed using `m4` and `xxd`. + +example syntax: +``` +00 00 00 00 ; this is an example binary source file +repeat(5,8f) ; 5 0x8f bytes +repeat(hex(a),bb) ; 10 0xbb bytes +repeat(0x40,00) ; 64 0x00 bytes +; ^ 0x prefix works too +ff ; single byte +00000000 ; 32-bit number +; ^ this is the comment character +``` + +if compilation hangs, you probably broke the syntax |