microsoft / devicescript

TypeScript for Tiny IoT Devices (ESP32, RP2040, ...)
https://microsoft.github.io/devicescript/
MIT License
3.25k stars 116 forks source link

rename bytecode.md to README.md #476

Closed samkho closed 1 year ago

samkho commented 1 year ago

Describe the bug In folder bytecode, documentation is in file bytecode.md. This does not auto-display in GitHub. Please rename to README.md so it does auto-display, just like in the folder compiler.

To Reproduce

  1. In GitHub, go to microsoft / devicescript / bytecode
  2. No documentation is shown, because documentation is not named README.md
  3. An extra click (on bytecode.md) is required to see documentation

Expected behavior Expect documentation for bytecode to auto-display in GitHub when entering the bytecode folder.

Screenshots Not needed.

Additional context When you enter the compiler folder, documentation auto-displays. Entering bytecode folder should do likewise.