Skip to content

Commit

Permalink
docs: fix typos and missing images (#640)
Browse files Browse the repository at this point in the history
  • Loading branch information
Dotneteer authored Nov 27, 2023
1 parent 3bae039 commit 2b24ace
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 9 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
Quick links:
- [What Klive IDE Is](#what-klive-ide-is)
- [Klive Documentation](https://dotneteer.github.io/kliveide/)
- [Release v0.30.2](https://github.com/Dotneteer/kliveide/releases/tag/v0.30.2)

## Announcement

Expand Down
4 changes: 2 additions & 2 deletions pages/getting-started/first-run.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ You can turn the machine on in debug mode with the `Ctrl+F5` key, using the **Ma
When you suspend (pause) the machine, you can continue running it in debug mode with `Ctrl+F5`. Also, while the machine is paused, you can move it into debug mode with any of these debugger commands:

- **Step Into**. This command executes the next Z80 instruction and pauses the machine again. Use the `F10` key, the **Machine | Step Into command, or the **Step Into** toolbar key.
- **Step Over**. This command executes the next Z80 instruction and pauses the machine again. Suppose the instruction is a subroutine call, an `RST` call, or a block operation (e.g., `LDIR`). In that case, the entire instruction is executed, and the machine pauses again at the next instruction following the call or the block operation. Use the `F11` key, the **Machine | Step Over command, or the **Step Over** toolbar key.
- **Step Out**. This command executes all Z80 instructions to the next return instruction and suspends running again at the return point. Use the `Shift+F11` key, the **Machine | Step Over command, or the **Step Over** toolbar key.
- **Step Over**. This command executes the next Z80 instruction and pauses the machine again. Suppose the instruction is a subroutine call, an `RST` call, or a block operation (e.g., `LDIR`). In that case, the entire instruction is executed, and the machine pauses again at the next instruction following the call or the block operation. Use the `F11` key, the **Machine | Step Over command**, or the **Step Over** toolbar key.
- **Step Out**. This command executes all Z80 instructions to the next return instruction and suspends running again at the return point. Use the `Shift+F11` key, the **Machine | Step Over command**, or the **Step Over** toolbar key.

> **Note**: The Step Out command may not work in every context. There are Z80 programs that do not use the `RET` statement (or its conditional equivalents) but manipulate the stack and use indirect jump statements. The Step Out command cannot work with such constructs.
Expand Down
21 changes: 14 additions & 7 deletions pages/getting-started/keyboard.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
import Image from 'next/image'
import mainKey from '../../public//images/getting-started/main-key.png'
import symbolKey from '../../public//images/getting-started/symbol-key.png'
import aboveKey from '../../public//images/getting-started/above-key.png'
import belowKey from '../../public//images/getting-started/below-key.png'
import glyphKey from '../../public//images/getting-started/glyph-key.png'
import sizingStart from '../../public//images/getting-started/sizing-start.png'
import sizingEnd from '../../public//images/getting-started/sizing-end.png'

# Using the Keyboard

Expand Down Expand Up @@ -29,21 +36,21 @@ This table shows a few examples:

| Example | Description
|-|:-|
| <Image src="/images/getting-started/main-key.png" alt="Hello" width="64" height="77" /> | The click will display `INPUT` (`i`) when you use the left mouse button or `INPUT` (`I`) with the right mouse button, depending on the current ZX Spectrum cursor mode. |
| <Image src="/images/getting-started/symbol-key.png" width="64" height="77" /> | The click will result in `AT` regardless of which mouse button you click. |
| <Image src="/images/getting-started/above-key.png" width="64" height="77" /> | The click will show `CODE` regardless of which mouse button you click.. |
| <Image src="/images/getting-started/below-key.png" width="64" height="90" /> | The click will display `IN` regardless of which mouse button you click. |
| <Image src="/images/getting-started/glyph-key.png" width="64" height="77" /> | The click will display a glyph with its top-left corner set if you click the left mouse button and the inverse of that glyph when you use the right mouse button. |
| <Image src={mainKey} alt="Hello" width="64" height="77" /> | The click will display `INPUT` (`i`) when you use the left mouse button or `INPUT` (`I`) with the right mouse button, depending on the current ZX Spectrum cursor mode. |
| <Image src={symbolKey} width="64" height="77" /> | The click will result in `AT` regardless of which mouse button you click. |
| <Image src={aboveKey} width="64" height="77" /> | The click will show `CODE` regardless of which mouse button you click.. |
| <Image src={belowKey} width="64" height="90" /> | The click will display `IN` regardless of which mouse button you click. |
| <Image src={glyphKey} width="64" height="77" /> | The click will display a glyph with its top-left corner set if you click the left mouse button and the inverse of that glyph when you use the right mouse button. |

## Resizing the Virtual Keyboard

When you move the mouse to the top border of the virtual keyboard, a sizing splitter bar appears:

<Image src="/images/getting-started/sizing-start.png" width="550" height="390" style={{marginTop: 20}} />
<Image src={sizingStart} width="550" height="390" style={{marginTop: 20}} />

Hold down the mouse key while over the splitter, and move it. As you move, Klive changes the keyboard size and resizes the emulator display accordingly:

<Image src="/images/getting-started/sizing-end.png" width="550" height="390" style={{marginTop: 20}} />
<Image src={sizingEnd} width="550" height="390" style={{marginTop: 20}} />

When you reach the desired size, release the mouse button.

Expand Down

0 comments on commit 2b24ace

Please sign in to comment.