Skip to content

Commit

Permalink
Update readme and tags
Browse files Browse the repository at this point in the history
  • Loading branch information
JNjenga committed Jul 24, 2021
1 parent 221ce92 commit cb93af5
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 7 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description = "A 6502 CPU emulator that runs in the terminal with a 40x25 displa
repository = "https://github.com/jnjenga/e6502"
readme = "README.md"
version = "0.1.0"
keywords = ["emulator", "TUI", "6502"]
keywords = ["emulator", "6502"]
edition = "2018"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
Expand Down
39 changes: 33 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# e6502

6502 CPU emulator that uses the ~~terminal~~ as user interface.
Developed for recreational and learing purposes.
**e6502** is an emulator that emulates the [6502 processor](https://en.wikipedia.org/wiki/MOS_Technology_6502). While it's being developed for recreational , it could be used as a teaching tool.

> The project is still being developed, might want to comeback after some time.
Expand All @@ -13,15 +11,44 @@ This is what I am working towards:

## Features

- 40x25 screen display
- 32x32 screen display
- Step through code
- Registers and memory editing and viewing

## Tech Stack

- [Rust](https://www.rust-lang.org/)
- [Ncurses](https://invisible-island.net/ncurses/) for Terminal User Interface (TUI)

- [Rust-SDL2](https://github.com/Rust-SDL2/rust-sdl2)

## Installation

The program has two binaries, a "compiler" called **e6502c** and the emulator called **e6502**

To build the compiler

```
cargo build --bin e6502c
```

To build the emulator

```
cargo build --bin e6502
```

## Running
The compiler expects two cli arguments `source_code_path` and `binary_output`

```
e6502c tests/asmcode.asm out.bin
```

The emulator expects one cli argument, `binary_program_path`

```
e6502 out.bin
```

## Resources

- [6502.org](6502.org/tutorials/6502opcodes.html)
Expand Down

0 comments on commit cb93af5

Please sign in to comment.