From 9cf92379d5fcf0076c25dae0935daab446c992cd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Karel=20Ko=C4=8D=C3=AD?= Date: Wed, 30 Aug 2017 21:37:53 +0200 Subject: Initial commit Adding work done so far. --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..bb60441 --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +QtMips +====== +MIPS CPU simulator for education purposes. + +Dependencies +------------ +* Qt 5 (version 4 is not tested but it might work) +* libelf + +Compilation +----------- +To compile whole project just run these commands: +``` +qmake /path/to/qtmips +make +``` +Where `/path/to/qtmips` is path to this project root. + +Running +------- +Because simulator it self is implemented as library you need to have that library +in common path where loader can found it. Which is not commonly a case, so you can +also run it using this command (in case of cli version, gui version is the same) +``` +LD_LIBRARY_PATH=qtmips_machine qtmips_cli/qtmips_cli +``` + +Tests +----- +There are two types of tests in QtMips. One type are unit tests for simulator it +self and second one are integration tests with command line client and real +compiled elf binaries. All these tests can be executed using script +`tests/run-all.sh` or one by one by running respective `test.sh` scripts. + +Source files for unit tests can be found in path `qtmips_machine/tests` and +integration tests are located in `tests` directory. + +Not implemented features +------------------------ +These are features that are not implemented and are not currently being planned as +being so. + +* Privileged instructions and all features dependent on it +* Coprocessors (so no floating point unit nor any other type) +* Peripherals -- cgit v1.2.3