Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
neelgala authored and aswaterman committed Jan 31, 2023
1 parent ca6217b commit 5245976
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 5245976

Please sign in to comment.