Skip to content

Commit 0a313aa

Browse files
committed
Update README.md
Added extra information of how use toy emulator and an advice about link/copy assets folder if you not install
1 parent 144be79 commit 0a313aa

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,19 @@ Plus you can control if you wish release or debug building using `-DCMAKE_BUILD_
3030

3131
In windows, you should add the "-g" parameter with the apropiated generator for VS2013 (you can get the list running cmake --help), or you can use the CMake GUI. With this, you can generate VS2013/4 project/solution files that you can open and compile, or use msbuild from a develop console. On window, to get wroking video and sound, you should put all necesary library and include files on a "lib" directory on the root dir of the source code. You could download a zip file with all necesary library and includes files for Windows, from http://cpu.zardoz.es/trillek-win32-lib.zip . If you use this file, you need to set the flag USE_STATIC_GLEW to true.
3232

33+
Rememeber to copy/link the assets folder to the directory build/bin/ (on Linux/OSX) or build/bin/Debug/ or build/bin/Release/
34+
INSTALLING
35+
----------
36+
37+
You could do a ```make install``` (or run Install solution on Visual Studio) to install the toy emulator + tools + library.
38+
3339
WHAT IT DOES ACTUALLY
3440
------------------
3541
### Tools
3642

3743
#### vm
3844

39-
Is a program that uses the Trillek Virtual Computer lib to run a TR3200 emulation. Can run in step mode or in "run mode" where it executes all the program without stopping. Needs C++ 11 *std::chrono compilance* for measuring times; **GLFW3 + GLM + OpenGL 3.2** is needed if you desire to see the virtual screen.
45+
Is a program that uses the Trillek Virtual Computer lib to run a TR3200 emulation. Can run in step mode or in "run mode" where it executes all the program without stopping. Needs C++ 11 *std::chrono compilance* for measuring times; **GLFW3 + GLM + OpenGL 3.3** is needed if you desire to see the virtual screen.
4046

4147
- Can load a little endian binary file with a ROM image with a max size of 32KiB.
4248
- Step mode, has an on-line disassembler. Each time that you press enter or 's' or 'S'
@@ -52,15 +58,23 @@ Usage:
5258
./vm -r romfile [other parameters]
5359
5460
Parameters:
55-
-r file or --rom file : RAW binary file for the ROM 32 KiB
61+
-r file or --rom file : RAW binary file for the ROM (32 KiB Max)
5662
-d file or --disk file : Disk file
63+
--nvram file : Non volatile RAM file
5764
-c val or --cpu val : Sets the CPU to use, from "tr3200" or "dcpu-16n"
58-
-m val or --disk val : How many RAM have the computer in KiB. Must be > 128 and < 1024. Will be round to a multiple of 128
65+
-x or --exec : Run the computer in normal mode without asking
66+
-m val or --mem val : How much RAM the computer will have, in KiB. Must be between 32 and 1024 and will be rounded to a multiple of 32
67+
--time : Show timing and speed info while running.
5968
--clock val : CPU clock speed in Khz. Must be 100, 250, 500 or 1000.
6069
-b val : Inserts a breakpoint at address val (could be hexadecimal or decimal).
70+
--ext-keys : Allow extra (non-standard) keycodes with virtual keyboard.
6171
-h or --help : Shows this help
6272
```
6373

74+
For example, if you run vc on the directory were is generated when you compile the project, you could simply :
75+
```./vc -r ../../asm/hello.ffi -x```
76+
And it would run the "Hello world" program.
77+
6478
#### pbm2font
6579

6680
Is a small tool that can generate a hexadecimal representation of a user font for the TDA display card. Uses as source image, a b&w ASCII **pbm** file (Gimp can generate it). It expects that the image have a width and height multiple of 8, as it divides the image in cells of 8x8 pixels each being a glyph of the font.
@@ -154,4 +168,4 @@ IMPLEMENTED DEVICES
154168

155169
TODO
156170
----
157-
See issues on github or the [Trello board](https://trello.com/b/ONRIy13Q)
171+
See issues on github or [Trello board](https://trello.com/b/ONRIy13Q)

0 commit comments

Comments
 (0)