Skip to content

Commit

Permalink
Update the README and Weaver.Weave's documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
teo-tsirpanis committed Jul 18, 2021
1 parent 09d4e00 commit 0a710d5
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ Sigourney is a lightweight toolkit that helps developers write weavers, tools th

## Projects using Sigourney

At the moment, Sigourney is known to be used by two projects, both of them developed by Sigourney's author.
At the moment, Sigourney is known to be used by two projects, both developed by Sigourney's author.

* [Covarsky][covarsky], a tool that brings co(ntra)variance in languages that don't support it like F#.
* [Farkle][farkle], an LALR parsing library that uses Sigourney for [its grammar precompiler][farkle-precompiler].

If your project uses Sigourney, feel free to open a pull request to add it to the list.
If your project uses Sigourney, feel free to open a pull request to add it to the list. It would really help with understanding if and how third parties are using it, and managing breaking changes.

## Why use Sigourney

Expand Down Expand Up @@ -91,7 +91,7 @@ Because Mono.Cecil treats assemblies in a framework-agnostic way, Sigourney shou

No MSBuild version is explicitly supported or unsupported, but Sigourney is only tested against the latest one. Earlier ones might be supported, or maybe not.

Sigourney was tested with SDK-style projects only. Legacy .NET Framework projects (the big, unreadable ones) are not known whether they work or not.
Sigourney is tested with SDK-style projects only. Legacy .NET Framework projects (the big, unreadable ones) are not known whether they work or not.

Like Mono.Cecil, Sigourney's version number will most likely stick in the `0.x.y` range. Patch releases will not break code, although they might upgrade libraries. Minor releases are more likely to break stuff but such impact will be attempted to be kept at a minimum.

Expand All @@ -102,6 +102,8 @@ Like Mono.Cecil, Sigourney's version number will most likely stick in the `0.x.y

Since Sigourney already supports incremental weaving through the `ProcessedBy` classes, fixing this issue has a low priority. Anybody interested can feel free to propose a solution.</s> This problem was fixed in Sigourney 0.3.0.

* Strong-naming assemblies is not supported when you build your project with a .NET Core-based edition of MSBuild.

## License

Sigourney is licensed under the [MIT license][mit], with no strings attached.
Expand Down
3 changes: 2 additions & 1 deletion Sigourney/Weaver.cs
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@ private static bool TryReadSymbols(AssemblyDefinition asm, ILogger log)
/// will be placed to the assembly, to instruct Sigourney not to weave it again.</remarks>
/// <param name="inputPath">The path of the assembly to weave.</param>
/// <param name="outputPath">The path where the weaved assembly will be stored.
/// Defaults to <paramref name="inputPath"/> if null.</param>
/// Defaults to <paramref name="inputPath"/> if null. It must not
/// be equal to <paramref name="inputPath"/>.</param>
/// <param name="fWeave">A delegate that performs the actual weaving. If it returns
/// <see langword="false"/>, weaving will stop and the assembly will not be modified.</param>
/// <param name="log">A Serilog <see cref="ILogger"/> that will
Expand Down

0 comments on commit 0a710d5

Please sign in to comment.