Skip to content

Commit

Permalink
cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
Doraku committed Oct 14, 2024
1 parent df84a9b commit b162e8b
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 12 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
# DefaultUnDo
DefaultUnDo is a simple [Command pattern](https://en.wikipedia.org/wiki/Command_pattern) implementation to ease the addition of an undo/redo feature.

[![NuGet](https://buildstats.info/nuget/DefaultUnDo)](https://www.nuget.org/packages/DefaultUnDo)
[![Coverage Status](https://coveralls.io/repos/github/Doraku/DefaultUnDo/badge.svg?branch=master)](https://coveralls.io/github/Doraku/DefaultUnDo?branch=master)
[![NuGet](https://img.shields.io/nuget/v/DefaultUnDo)](https://www.nuget.org/packages/DefaultUnDo)
[![preview package](https://img.shields.io/badge/preview-package-blue?style=flat&logo=github)](https://github.com/Doraku/DefaultUnDo/pkgs/nuget/DefaultUnDo)
![continuous integration status](https://github.com/doraku/defaultundo/workflows/continuous%20integration/badge.svg)
[![preview package](https://img.shields.io/badge/preview-package-blue?style=flat&logo=github)](https://github.com/Doraku/DefaultUnDo/packages/26448)
[![Coverage Status](https://coveralls.io/repos/github/Doraku/DefaultUnDo/badge.svg?branch=master)](https://coveralls.io/github/Doraku/DefaultUnDo?branch=master)

- [Api documentation](./documentation/api/DefaultUnDo.md 'Api documentation')
- [Api documentation](./documentation/api/index.md 'Api documentation')
<a/>

- [Requirement](#Requirement)
- [Overview](#Overview)
- [Dependencies](#Dependencies)

<a name='Requirement'></a>
# Requirement
Compatible from .NETStandard 1.0.
For development, a C#8.0 compatible environment, net framework 4.8, net core 1.0 and netcore 3.0 are required to build and run all tests (it is possible to disable some target in the test project if needed).
Compatible from .NETStandard 2.0.
For development, net framework 4.8 and net8.0 are required to build and run all tests.

<a name='Overview'></a>
# Overview
Expand Down Expand Up @@ -197,4 +198,11 @@ manager.Redo();

To keep track of the modification, a `Version` property is available on the manager.

Missing something? you can easily extend what you need by creating your own implementations of the `IUnDo` interface and extension methods to ease the usage. Feel free to open an issue or send a pull request.
Missing something? you can easily extend what you need by creating your own implementations of the `IUnDo` interface and extension methods to ease the usage. Feel free to open an issue or send a pull request.

<a name='Dependencies'></a>
Relies on these awesome projects:
- [Coverlet](https://github.com/coverlet-coverage/coverlet)
- [Polyfill](https://github.com/SimonCropp/Polyfill)
- [Roslynator](https://github.com/JosefPihrt/Roslynator)
- [XUnit](https://github.com/xunit/xunit)
4 changes: 1 addition & 3 deletions source/DefaultUnDo/DefaultDocumentation.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
"GeneratedAccessModifiers": "Public,Protected,ProtectedInternal",
"GeneratedPages": "Assembly,Types,Members",
"FileNameFactory": "Name",
"AssemblyPageName": "DefaultUnDo",
"LinksOutputFilePath": "..\\..\\documentation\\DefaultUnDo.txt",
"LinksBaseUrl": "https://github.com/Doraku/DefaultUnDo/blob/master/documentation/api/",
"NamespaceDocItem": {
Expand All @@ -13,6 +12,5 @@
"TableOfContents"
],
"Markdown.TableOfContentsModes": "IncludeKind,IncludeSummary"
},
"LogLevel": "Trace"
}
}
2 changes: 1 addition & 1 deletion source/DefaultUnDo/DefaultUnDo.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
</PropertyGroup>

<ItemGroup>
<PackageReference Include="DefaultDocumentation" Version="0.9.0-beta01" PrivateAssets="all" Condition="'$(TargetFramework)'=='net8.0'" />
<PackageReference Include="DefaultDocumentation" Version="0.9.0-beta01" PrivateAssets="all" Condition="'$(Version)' != '0.0.0' AND '$(TargetFramework)' == 'net8.0'" />
<PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="All" />
</ItemGroup>

Expand Down
4 changes: 3 additions & 1 deletion source/Directory.Build.props
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,12 @@
<AssemblyOriginatorKeyFile>$(MSBuildThisFileDirectory)..\..\ds.snk</AssemblyOriginatorKeyFile>
<AssemblyOriginatorKeyFile Condition="'$(GITHUB_ACTIONS)' == 'true'">$(MSBuildThisFileDirectory)..\ds.snk</AssemblyOriginatorKeyFile>

<Version>0.0.0</Version>

</PropertyGroup>

<ItemGroup>
<PackageReference Include="DefaultCSharp" Version="1.0.0-test06" PrivateAssets="all" />
<PackageReference Include="DefaultCSharp" Version="1.0.0-test07" PrivateAssets="all" />
</ItemGroup>

</Project>

0 comments on commit b162e8b

Please sign in to comment.