gbdev / gbdev.github.io

gbdev institutional website: showcases projects and hosts some community content
https://gbdev.io
GNU General Public License v3.0
23 stars 13 forks source link

Editor configuration #35

Open pinobatch opened 2 years ago

pinobatch commented 2 years ago

From https://gbdev.io/guides/asmstyle.html#recommendations (source code is https://github.com/gbdev/gbdev.github.io/blob/dev/list/guides/asmstyle.md)

Please use the .asm (or .s) file extensions, not .z80. The GB CPU isn't a Z80, so syntax highlighters get it mostly right, but not quite. And it helps spreading the false idea that the GB CPU is a Z80. 😢

Syntax highlighters get it even less right when .s and .asm default to x86 syntax on x86 PCs or to ARM syntax on ARM PCs. Would it be appropriate for some page on this site to give instructions to configure popular text editors (and frameworks used by multiple editors, such as GtkSourceView) to distinguish files in assembly language for SM83 instruction set from files in assembly language for other instruction sets?

avivace commented 2 years ago

I agree, it's not a great suggestion, and I suppose z80 would in case case less worse (as far as syntax highlighting goes) than confusing with other x86 syntaxes. I'll open a PR to remove the paragraph.