BodgeMaster
/
FOSS-VG
1
0
Fork 0
Code Issues 21 Pull Requests Projects Releases Wiki Activity

Code style guidelines and resources/README: Minor documentation changes

master
BodgeMaster 2024-03-24 10:50:30 +01:00
parent 8f8d51f459
commit d1c855857c
2 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
code_style.md
View File

@ -22,10 +22,8 @@ each file.
Don't use excessive comments, use descriptive names instead. Don't use excessive comments, use descriptive names instead.
There is no such thing as too long names (within reason, of course). 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. Put comments on their own lines.
Format comments to improve readability, don't have long single-line comments.
Indent by four spaces. Indent by four spaces.

6
resources/README.md
View File

@ -59,3 +59,9 @@ Usage: `check_endianness > header_file`
Note that, while this tool should in theory be able to detect Note that, while this tool should in theory be able to detect
PDP and Honeywell-316-style endianness, the FOSS-VG project itself PDP and Honeywell-316-style endianness, the FOSS-VG project itself
does not support these. 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.