Give less space to the "syntax-highlighting" paragraph in the README

gbdev / gb-asm-tutorial

Learn to create games for the Game Boy using Assembly

http://gbdev.io/gb-asm-tutorial/

MIT License

100 stars 31 forks source link

Give less space to the "syntax-highlighting" paragraph in the README #50

Closed avivace closed 1 year ago

avivace commented 1 year ago

This paragraph https://github.com/gbdev/gb-asm-tutorial#syntax-highlighting in the README is pretty confusing. It makes you think it's a mandatory step or something you need , while in reality it should just serve as reference on how that file is built/obtained, but most of the times it's not a useful information, we ship the build .js anyway in the repository..

Maybe move this into a separate .MD file? or at least mention when/how you would need to rebuild that

ISSOtm commented 1 year ago

Then that could get moved to a README.md next to the JS file.