From 01c36086d51a3fbec7fa04d2f92a79a32faa8ad2 Mon Sep 17 00:00:00 2001 From: Neel Gala Date: Sat, 14 Jan 2023 13:48:36 +0530 Subject: updated readme --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index d41015a..dec6003 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,15 @@ Instruction syntaxes used in this project are broadly categorized into three: ``` $import rv32_zkne::aes32esmi ``` + +### RESTRICTIONS + +Following are the restrictions one should keep in mind while defining $pseudo\_ops and $imported\_ops + +- Pseudo-op or already imported instructions cannot be imported again in another file. One should + always import base-instructions only. +- While defining a $pseudo\_op, the base-instruction itself cannot be a $pseudo\_op + ## Flow for parse.py The `parse.py` python file is used to perform checks on the current set of instruction encodings and also generates multiple artifacts : latex tables, encoding.h header file, etc. This section will provide a brief overview of the flow within the python file. -- cgit v1.1