6502/champ
1
0
Fork 0
mirror of https://github.com/specht/champ.git synced 2024-11-29 20:49:24 +00:00
Code Issues Projects Releases Wiki Activity

documentation

Browse Source
This commit is contained in:
Michael Specht 2018-02-14 23:35:32 +01:00
parent 619d1c35b2
commit 4c6e1e4edd
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -9,10 +9,7 @@ This is a 65C02 emulator / profiler that enables you to really get to know your
* average frame rate * average frame rate
* see how much time is spent in which subroutine * see how much time is spent in which subroutine
* watch variables (single variables or pairs) * watch variables (single variables or pairs)
* no dependencies except Ruby, gcc and Merlin32
* no dependencies but Ruby, gcc and Merlin32
![Champ Screenshot](doc/screenshot.png?raw=true "Fig. 1 Champ Screenshot")
## Usage ## Usage
@ -39,6 +36,14 @@ We specified some source files (they'll get compiled automatically) and some obj
Furthermore, we can disable subroutines by replacing the first opcode with a RTS. This is necessary in some cases because Champ does not emulate hardware and thus can not load data from disk, for example. Furthermore, we can disable subroutines by replacing the first opcode with a RTS. This is necessary in some cases because Champ does not emulate hardware and thus can not load data from disk, for example.
## Miscellaneous To start champ, type:
```
$ ./champ.rb --max-frames 100 plot3d.yaml
```
This will run the emulator and write the HTML report to `report.html`. If you do not specify the maximum number of frames, you can still cancel the emulator by pressing Ctrl+C at any time. If you need fast results and don't need the animated GIF of all frames, specify the `--no-animation` flag, which will still give you all the information but without the animation.
![Champ Screenshot](doc/screenshot.png?raw=true "Fig. 1 Champ Screenshot")
By the way, there's a full-fledged, standalone, no-dependencies GIF encoder in `pgif.c` that writes animated GIFs and uses some optimizations to further minimize space. By the way, there's a full-fledged, standalone, no-dependencies GIF encoder in `pgif.c` that writes animated GIFs and uses some optimizations to further minimize space.