1
0
mirror of https://github.com/lefticus/6502-cpp.git synced 2024-06-09 04:29:31 +00:00

Add readme.md with basic usage

This commit is contained in:
Jason Turner 2016-07-07 15:21:40 -06:00
parent 76bb4371a7
commit b5dd153cd4

54
examples/readme.md Normal file
View File

@ -0,0 +1,54 @@
# About
Attempts to translate x86 assembly into mos6502 assembly.
# Why?
Why not? I figured I just barely knew some x86 and some 6502, so why not learn some more about both. Besides, this project can actually have some interesting applications.
# Example
After compilation (requires a full C++14 compiler), you can run something like this:
```assembly_x86
// test.asm
main:
movb $1, 53280
xorl %eax, %eax
ret
```
```bash
cat test.asm | x86-to-6502
```
And get this output:
```
main:
ldy #$1
sty 53280
lda $00
rts
```
# Caveats
* Nothing is guaranteed. This could break your computer. Who knows?
* All values are truncated to 8 bit. We have no support for 16bit math or pointers yet
* Only as many instructions are supported as I have needed to support to get my test cases working
# To Do
*Everything*
Well, lots of things.
* Better / more efficient translation
* Support for 16bit math? Maybe? We need to at least be able to do 16bit pointer math
* Consider supporting the "Sweet 16" virtual 16bit CPU that Woz designed?
* Maybe for 16bit operation we try to detect if the input code is working on 8bit registers or 16+bit registers and do the right thing?
* Support for more CPU instructions
* A test suite