Commit MetaInfo

Revisioneea6531ce6c97a2d753cbadc465e2e64efadb380 (tree)
Time2019-02-03 20:39:42
Authoringlorion <homemicro@ingl...>
Commiteringlorion

Log Message

documented how to use the emulator

Change Summary

Incremental Difference

diff -r 68d2992bdaeb -r eea6531ce6c9 docs/emulator.txt
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/emulator.txt Sun Feb 03 03:39:42 2019 -0800
@@ -0,0 +1,31 @@
1+#+TITLE: The Emulator
2+
3+The Home Micro source code repository contains an emulator that can be
4+used to run programs and firmware written for the Home Micro on other
5+computers. The source code for the emulator is in the emulator
6+directory of the repository.
7+
8+To start the emulator, a ROM image file named rom.bin must be present
9+in the directory the emulator is run from. In addition, to load a
10+program, a file named cartridge.bin must be present in the same
11+directory.
12+
13+The following commands, starting from the top of the Home Micro source
14+repository, will create a ROM image and a cartridge image and place
15+both in the emulator directory. The emulator will also be built and
16+invoked. The require that all the necessary software dependencies are
17+present on the system. For more information on those, see
18+[[file:requirements.txt]].
19+
20+#+BEGIN_SRC sh
21+homemicro$ cd rom
22+rom$ make
23+rom$ cp rom.bin ../emulator/
24+rom$ cd ../apps/testkeys
25+testkeys$ make
26+testkeys$ cp testkeys.bin ../../emulator/cartridge.bin
27+testkeys$ cd ../../emulator
28+emulator$ ./configure
29+emulator$ make
30+emulator$ ./hm1000
31+#+END_SRC
Show on old repository browser