diff --git a/code_style.md b/code_style.md index af58d56..346ba4d 100644 --- a/code_style.md +++ b/code_style.md @@ -22,10 +22,8 @@ each file. Don't use excessive comments, use descriptive names instead. There is no such thing as too long names (within reason, of course). -Don't have comments that go beyond 80 characters per line, preferably -slightly less. - Put comments on their own lines. +Format comments to improve readability, don't have long single-line comments. Indent by four spaces. diff --git a/resources/README.md b/resources/README.md index 15442a0..6f27023 100644 --- a/resources/README.md +++ b/resources/README.md @@ -59,3 +59,9 @@ Usage: `check_endianness > header_file` Note that, while this tool should in theory be able to detect PDP and Honeywell-316-style endianness, the FOSS-VG project itself does not support these. + +## region_files + +Exactly what the name says. At this point just a random region file I grabbed +from Minecraft, will probably contain synthetic files for test cases in the +future as well.