From 0a313aa62d9985b4b4d02ba35033ce7205e2bdf3 Mon Sep 17 00:00:00 2001 From: Luis Date: Thu, 12 Mar 2015 19:59:36 +0100 Subject: [PATCH] Update README.md Added extra information of how use toy emulator and an advice about link/copy assets folder if you not install --- README.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 32acde9..331bb7e 100644 --- a/README.md +++ b/README.md @@ -30,13 +30,19 @@ Plus you can control if you wish release or debug building using `-DCMAKE_BUILD_ 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. +Rememeber to copy/link the assets folder to the directory build/bin/ (on Linux/OSX) or build/bin/Debug/ or build/bin/Release/ +INSTALLING +---------- + +You could do a ```make install``` (or run Install solution on Visual Studio) to install the toy emulator + tools + library. + WHAT IT DOES ACTUALLY ------------------ ### Tools #### vm -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. +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. - Can load a little endian binary file with a ROM image with a max size of 32KiB. - Step mode, has an on-line disassembler. Each time that you press enter or 's' or 'S' @@ -52,15 +58,23 @@ Usage: ./vm -r romfile [other parameters] Parameters: - -r file or --rom file : RAW binary file for the ROM 32 KiB + -r file or --rom file : RAW binary file for the ROM (32 KiB Max) -d file or --disk file : Disk file + --nvram file : Non volatile RAM file -c val or --cpu val : Sets the CPU to use, from "tr3200" or "dcpu-16n" - -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 + -x or --exec : Run the computer in normal mode without asking + -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 + --time : Show timing and speed info while running. --clock val : CPU clock speed in Khz. Must be 100, 250, 500 or 1000. -b val : Inserts a breakpoint at address val (could be hexadecimal or decimal). + --ext-keys : Allow extra (non-standard) keycodes with virtual keyboard. -h or --help : Shows this help ``` +For example, if you run vc on the directory were is generated when you compile the project, you could simply : +```./vc -r ../../asm/hello.ffi -x``` +And it would run the "Hello world" program. + #### pbm2font 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 TODO ---- -See issues on github or the [Trello board](https://trello.com/b/ONRIy13Q) +See issues on github or [Trello board](https://trello.com/b/ONRIy13Q)