Convert readme to markdown

This commit is contained in:
Auios 2024-02-11 21:56:56 -05:00
parent 365071072b
commit 4162c9b232
2 changed files with 29 additions and 18 deletions

29
readme.md Normal file
View File

@ -0,0 +1,29 @@
# 8608 - An 8-bit data, 16-bit address, CISC architecture.
For a list of instructions, see [instructionList.txt](instructionList.txt).
## How to use the assembler:
1. Install `bllua3` from [https://notabug.org/redo/bllua3](https://notabug.org/redo/bllua3)
2. Download this repo somewhere into the Blockland folder.
3. In BL console, execute:
```
luaexec("your_path/assembler-8608.lua");
```
4. To assemble a program, place a 1x1f ghost brick on the top-left corner of the ROM, face forward, and in BL console do:
```
AssembleBuildFile("other_path/filename.asm", "RomX RomY RomZ");
```
where `RomX` is the width of the ROM, `RomY` is the depth front to back, and `RomZ` is the height in bits, i.e., "16 16 8".
You can also run the assembler from the command line to get a memory dump and disassembly in stdout, if you have lua installed:
```
luajit "your_path/assembler-8608.lua" "other_path/filename.asm"
```
## How to use the emulator:
1. Install love2d from [https://love2d.org](https://love2d.org)
2. Open a command prompt in the "emulator" folder and run:
```
love . C:/path/filename.asm
```

View File

@ -1,18 +0,0 @@
8608 - an 8-bit data, 16-bit address, CISC architecture.
For a list of instructions, see instructionList.txt
How to use the assembler:
1. Install bllua3 from https://notabug.org/redo/bllua3
2. Download this repo somewhere into the Blockland folder
3. In BL console,
luaexec("your_path/assembler-8608.lua");
4. To assemble a program, place a 1x1f ghost brick on the top-left corner of the ROM, face forward, and in BL console do
AssembleBuildFile("other_path/filename.asm", "RomX RomY RomZ"); where RomX is the width of the ROM, RomY is the depth front to back, and RomZ is the height in bits, i.e. "16 16 8"
You can also run the assembler from the command line to get a memory dump and disassembly in stdout, if you have lua installed:
luajit "your_path/assembler-8608.lua" "other_path/filename.asm"
How to use the emulator:
1. Install love2d from https://love2d.org
2. Open a command prompt in the "emulator" folder and run "love . C:/path/filename.asm"