README.md

QTranslator

💬 Desciption

The goal of this project is to transpile an assembly file (.asm) into a quantum assembly file (.qasm).
The goal of the initial proof of concept was to create a quantum calculator.

💻 Install

🚀 Clone repository

git clone git@github.com:PoCInnovation/QTranslator.git

⚠️ Requirement

• CMake >= 3.17
• C++20

✍️ How to write .asm

📋 Example

Create a file operations.asm:

; operations.asm

xor rax, rax

cmp BYTE[rax], 0
je endl
inc rax

endl:
ret

🏁 Quick-Start

make
./QTranslator operations.asm

ℹ️ More informations

📒 Manual

USAGE:
        ./QTranslator file.asm [OPTIONS]

DESCRIPTION:
        file.asm         ASM source code to be translated into QASM

OPTIONS:
        -h --help       Display this help menu
        -o --output     Name of the generated QASM file
RETURN VALUE:
        0               if transpilation succeed
        1               if transpilation failed

✅ Build and run unit tests

To build the tests, execute the following command :
make tests

After that, you will be able to run them using the following command :
./QTranslatorTests

💡 Build Tips

If you want to remove all objects files :
make clean

👤 Authors

Martin OLIVIER	Jean-Baptiste DEBIZE	Théo FOURCAT