Skip to content

Latest commit

 

History

History
127 lines (97 loc) · 4.73 KB

user_manual.md

File metadata and controls

127 lines (97 loc) · 4.73 KB

IAT2 Logo

User Manual

Table of Contents

1. Introduction

Welcome to the User Manual for IAT2. This guide is designed to help you understand and use the features of our product efficiently.

2. Getting Started

2.1 Installation

Requirements:

  • Git
  • CMake
  • g++ (latest version)
  • gcc (latest version)

if you don't have git installed CLICK HERE TO DOWNLOAD.
if you don't have cmake installed CLICK HERE TO DOWNLOAD.
if you don't have gcc installed CLICK HERE TO DOWNLOAD.
if you don't have msys2 installed CLICK HERE TO DOWNLOAD.

Follow these steps to install IAT2:

  1. Clone the repository: git clone https://github.com/algosup/2023-2024-project-3-virtual-processor-team-2.git
  2. Go at the project root
  3. Create an empty directory named "bin" at the project root
  4. Go at the project root
  5. Build the project
    • How to use with mingw: (Windows)
      • Execute cmake -S . -B Build -G "MinGW Makefiles"
      • Execute cd Build
      • Execute mingw32-make
    • How to use with msys2: (Windows)
      • Execute cmake -S . -B Build -G "MSYS Makefiles"
      • Execute cd Build
      • Execute make
    • How to use with make: (Linux)
      • Execute cmake -S . -B Build
      • Execute cd Build
      • Execute make

3. Execution

IAT2

IAT2 is planned to compile and execute in a single step, if you want to compile and execute separatly your can refer to Assembler (Compile) and Virtual Processor (Execute).

Assembler

Command alias Usage output
2at2 <path/file.aop> [param] Compile your .aop file binary file
2at2 --help 2at2 -h Display the list of command for 2at2
2at2 --version 2at2 -v Display the version of 2at2
2at2 <file> --debug 2at2 <file> -d Compile the program with the debugger 2at2.log

Virtual Processor

Type: vat2 to run the virtual processor and open the virtual terminal.

Virtual terminal commands:

Command Usage
<path/binary_file> Execute your binary file
help Display the list of command for vat2
clear Clear the terminal
version Display the version of vat2
exit Close the terminal

4. Troubleshooting

4.1 Common Issues

Issue Solution
Writing on register 3 Don't write on register 3

Your issue is not here ?
You can also refer to GitHub Issues.

4.2 FAQs

Can I use negative numbers ?

  • No, unfortunately negative numbers are not handle yet, but planned for the V2.

Can I use VAT2 to execute my own binary file ?

  • Yes and No, You can only if you use the same binary syntax as 2AT2.

Can I execute 2AT2's binary on real hardware ?

  • Probably No, unless you find a real hardware using the same syntax (If you find it, tell us)

5. Appendix

5.1 Glossary

Name Definition
IAT2 Integral Assembler Team 2 (Assembler + Virtual Processor)
2AT2 Assembler Assembly Team 2
VAT2 Virtual processor Assembly Team 2
.aop Aop Original Program (extension of AT2 language)
AT2 Assembly Team 2

5.2 AT2 documentation

You can refer to the AT2's documentation HERE.