Skip to content

Commit

Permalink
Update the readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
inversionhourglass committed Oct 12, 2024
1 parent 66e513f commit 6ce11e8
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 3 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

中文 | [English](https://github.com/inversionhourglass/Cli4Fody/blob/master/README_en.md)

Cli4Fody是一个命令行工具,用于管理和修改`FodyWeavers.xml`文件。通过该工具,可以让部分Fody插件实现完全零侵入式的MSIL修改。
Cli4Fody是一个命令行工具,用于管理Fody插件和修改`FodyWeavers.xml`文件。通过该工具,可以让部分Fody插件实现完全零侵入式的MSIL修改。

## 快速开始

Expand Down Expand Up @@ -74,6 +74,10 @@ Cli4Fody是一个命令行工具,用于管理和修改`FodyWeavers.xml`文件
</Weavers>
```

- `-pv, --package-version`

插件版本,`--addin`的子配置项。当指定该参数后,Cli4Fody会为每个项目添加当前插件的NuGet,版本为当前参数值。该参数可以用来解决Fody插件间接依赖MSBuild任务无效的问题,该参数为每个项目添加NuGet直接依赖。需要注意的是,为了加快Cli4Fody的执行速度,NuGet采用了`--no-restore`的方式进行安装。

- `-m, --mode <overwrite|default>`

操作模式,`--addin`的子配置项,默认`overwrite`,新建或重写以存在的`--addin`配置节点;`default`表示仅作为默认配置,如果`--addin`配置节点已存在则不进行任何修改。注意`-m, --mode`作为`--addin`的子配置项,必须在`--addin`之后指定。
Expand Down
6 changes: 5 additions & 1 deletion README_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[中文](https://github.com/inversionhourglass/Cli4Fody/blob/master/README.md) | English

Cli4Fody is a command-line tool used for managing and modifying `FodyWeavers.xml` files. Through this tool, some Fody plugins can achieve completely non-intrusive MSIL modifications.
Cli4Fody is a command-line tool used for managing Fody addins and modifying `FodyWeavers.xml` files. Through this tool, some Fody plugins can achieve completely non-intrusive MSIL modifications.

## Quick Start

Expand Down Expand Up @@ -74,6 +74,10 @@ The `FodyWeavers.xml` after executing the command:
</Weavers>
```

- `-pv, --package-version`

Plugin version, a sub-option of `--addin`. When this parameter is specified, Cli4Fody will add the NuGet package of the current plugin to each project, with the version being the current parameter value. This parameter can be used to resolve issues where indirect dependencies on MSBuild tasks by Fody plugins are ineffective. By adding a direct NuGet dependency to each project, this issue can be mitigated. It's important to note that to speed up the execution of Cli4Fody, NuGet packages are installed using the `--no-restore` option.

- `-m, --mode <overwrite|default>`

Operation mode, a sub-option of `--addin`. The default is `overwrite`, which creates or overwrites an existing `--addin` configuration node. `default` means to set it as the default configuration; if the `--addin` configuration node already exists, no changes are made. Note that `-m, --mode` must be specified after `--addin` as a sub-option of `--addin`.
Expand Down
2 changes: 1 addition & 1 deletion src/Cli4Fody/Cli4Fody.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<Nullable>enable</Nullable>
<PackAsTool>true</PackAsTool>
<ToolCommandName>fody-cli</ToolCommandName>
<Description>Fody command-line tool for manipulating the configuration file FodyWeavers.xml</Description>
<Description>Fody command-line tool for manipulating fody addins and the configuration file FodyWeavers.xml</Description>
<PackageTags>Fody</PackageTags>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
<SignAssembly>true</SignAssembly>
Expand Down

0 comments on commit 6ce11e8

Please sign in to comment.