The instruction set is the most important component of the Computer Architecture. To help users quickly and correctly understand the definition and behavior of instructions, the Computer Specification uses many pages to provide textual descriptions and pseudocode for each instruction.
ISAManim aims to create a well-using framework to generate animations presenting the function of one instruction or an instruction sequence. The project is developed based on Manim, a Python-based animation framework for mathematics and algorithms.
Please check the full ISAManim document at https://wangeddie67.github.io/isa_manim/.
The whole project is developed based on Python3.
Page Installation provides the flow to install Manim on different OSs.
The typical process to install Manim in Ubuntu is as follows:
# Install requirements of Manim
sudo apt update
sudo apt install build-essential python3-dev libcairo2-dev libpango1.0-dev ffmpeg
# Install python package manager
sudo apt install python3-pip
# Install Manim
pip3 install manimFollow commands to clone the project to local.
# git clone repository
git clone [email protected]:wangeddie67/isa_manim.git
# install requirements
pip3 install -r isa_manim/requirements.txtMkDocs is applied to generate the document for this project. The environment of MkDocs can be set up by following commands:
cd /root/to/isa_sim_utils/docs
# Install MkDocs and plugin
pip3 install -r requirements.txtThe document can be generated by following commands:
make docUsers can access the generated documents in the directory docs/site. The index page of generated documents is docs/site/index.html.