diff options
author | Yann Herklotz <ymherklotz@gmail.com> | 2018-03-10 23:28:18 +0000 |
---|---|---|
committer | Yann Herklotz <ymherklotz@gmail.com> | 2018-03-10 23:28:18 +0000 |
commit | cd5ea3e038308bb1955b19beaaa93c214496a821 (patch) | |
tree | ac048c6f7b8abe2fd645d4faeb4c43700e4d52e9 | |
parent | 8638f32c4624d8d7b225eaf43333ba926c5acaf0 (diff) | |
download | Compiler-cd5ea3e038308bb1955b19beaaa93c214496a821.tar.gz Compiler-cd5ea3e038308bb1955b19beaaa93c214496a821.zip |
Added more doc and added to vagrantfile
-rw-r--r-- | README.md | 24 | ||||
-rw-r--r-- | Vagrantfile | 3 |
2 files changed, 27 insertions, 0 deletions
@@ -12,6 +12,27 @@ The project is structured in three directories. ## Usage +The necessary dependencies are: `make bison flex g++-mips-linux-gnu qemu tidy`. + +### Vagrant +All the necessary dependencies and correct environment can be installed using Vagrant and the +provided vagrant file. This can be done using the following commands. + +``` shell +# Installing the virtual machine +vagrant up + +# ssh into the machine +vagrant ssh + +# cd into the correct directory +cd /vagrant +``` + +The tests and builds can then be run from there. + +### Build + To use the compiler and test it out, together with the lexer and parser, the [`makefile`](/makefile) can be used. The main compiler can be built using the following commands. @@ -35,6 +56,9 @@ These can then be tested using the following shell scripts. # Running tests for the compiler ./run_test_deliverable.sh +# Running smaller testbench on compiler +./test_compiler.sh + # Running tests for the parser ./test_parser.sh diff --git a/Vagrantfile b/Vagrantfile index 1f53d5d..501a680 100644 --- a/Vagrantfile +++ b/Vagrantfile @@ -51,5 +51,8 @@ Vagrant.configure(2) do |config| # QEMU run-time emulator sudo apt-get -y install qemu + # Tidy command + sudo apt-get -y install tidy + SHELL end |