From c4c75095a72d5dffa1e5c07434bc7ebd2d9147ea Mon Sep 17 00:00:00 2001 From: ShrlAlgo <40654941+ShrlAlgo@users.noreply.github.com> Date: Thu, 4 Sep 2025 16:31:18 +0800 Subject: [PATCH] Update README with usage and upgrade instructions --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 33a3dc3..4e52f2a 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,16 @@ -- 使用该包的项目,需要使用新的.Net SDK 样式,如果不是,可以在```https://marketplace.visualstudio.com/vs```或者扩展-管理扩展,搜索.NET Upgrade Assistant安装 +# 注意事项 + - 使用该包的项目的源生成器,需要使用新的.Net SDK 样式,如果不是,可以在```https://marketplace.visualstudio.com/vs```或者扩展-管理扩展,搜索.NET Upgrade Assistant安装 - 之后项目右键升级到SDK(选最后一项 将项目转换为SDK样式)。 - 右键RevitGen项目,打包,生成nuget,可以修改版本。 -- 在插件项目去引用nuget包,本地路径需要修改nuget.config中的相对路径。 +- 在插件项目本地去引用nuget包,本地路径需要修改nuget.config中的相对路径。 +# 使用方法 - 使用```partial```修饰你的命令类 - 使用```RevitCommand```生成命令和面板 - ```CommandHandler```来定义运行的逻辑方法 - 如果是路径的图标的话,需要属性窗口中把生成方式改成嵌入式资源 - 命令自带```UIApplication```,```UIDocument```,```Document```,```ActiveView```等属性 - 自带事务处理,不需要使用默认事务时,可以使用```[RevitCommand("测试", UsingTransaction = false)]``` -- 命令的特性会生成一个RevitGenApplication的类,注册命令,生成面板。 +- 源生成器会根据命令的特性会生成一个的按钮,并在```RevitGenApplication```自动注册。 ``` using Autodesk.Revit.DB; using Autodesk.Revit.UI;