From 36380133f4c6050b027db5d83edca6994458d85a Mon Sep 17 00:00:00 2001 From: liangkangnan Date: Wed, 18 Jan 2023 10:43:58 +0800 Subject: [PATCH] regtool: update README Signed-off-by: liangkangnan --- tools/regtool/README.md | 47 +++++++++++++++++++++++------------------ 1 file changed, 27 insertions(+), 20 deletions(-) diff --git a/tools/regtool/README.md b/tools/regtool/README.md index a54c2e8..1eeb8cc 100644 --- a/tools/regtool/README.md +++ b/tools/regtool/README.md @@ -1,21 +1,28 @@ -# 使用方法 - -## 1.生成RTL文件 - -``` -regtool.py -r -t . xxx.hjson -``` - -其中.表示在当前目录生成。 - -## 2.生成C语言头文件 - -``` -regtool.py -D -o xxx.h xxx.hjson -``` - -表示在当前目录生成xxx.h头文件。 - - - +# 使用方法 + +安装依赖。 +``` +$ pip3 install --user hjson +$ pip3 install --user mistletoe +$ pip3 install --user mako +``` + +## 1.生成RTL文件 + +``` +regtool.py -r -t . xxx.hjson +``` + +其中.表示在当前目录生成。 + +## 2.生成C语言头文件 + +``` +regtool.py -D -o xxx.h xxx.hjson +``` + +表示在当前目录生成xxx.h头文件。 + + + 详细说明文档见[这里](https://docs.opentitan.org/doc/rm/register_tool/)。 \ No newline at end of file