Document Lynx

docs/api/target-platforms.md

@@ -61,6 +61,8 @@ The compiler emits NES files.
 For more complex programs, you need to create your own "platform" definition.  
 Read [the NES programming guide](./famicom-programming-guide.md) for more info.
 
+* `atari_lynx` – Atari Lynx
+
 * `vcs` – Atari VCS (also known as Atari 2600), 4K cartridge (experimental)
 
 * `a8` – Atari 8-bit computers.

docs/doc_index.md

@@ -58,6 +58,8 @@
 
 * [NES-only modules](stdlib/nes.md)
 
+* [Atari Lynx-only modules](stdlib/lynx.md)
+
 * [Game Boy–only modules](stdlib/gb.md)
 
 * [X16–only modules](stdlib/x16.md)

docs/stdlib/lynx.md

@@ -0,0 +1,36 @@
+[< back to index](../doc_index.md)
+
+# Atari Lynx-oriented modules
+
+## atari_lynx_hardware
+
+The `atari_lynx_hardware` module is imported automatically on NES targets.
+
+It also implements a joystick API compatible with the `joy` module.
+
+TODO
+
+#### `void lynx_init()`
+
+TODO
+
+#### `void lynx_wait_suzy()`
+
+TODO
+
+#### `alias input_a = input_btn`
+
+1 if A button pressed, 0 if not pressed.
+
+#### `byte input_b`
+
+1 if B button pressed, 0 if not pressed.
+
+#### `void read_joy()`
+
+Reads the joypad.
+
+#### `void lynx_reset_joy()`
+#### `alias reset_joy = lynx_reset_joy!`
+
+Resets the state variables.