Skip to content

Commit

Permalink
Add README to NuGet package (#423)
Browse files Browse the repository at this point in the history
  • Loading branch information
sys27 committed Nov 13, 2021
1 parent b334fd9 commit 7460875
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 9 deletions.
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Master: [![Build Status](https://exit.visualstudio.com/xFunc/_apis/build/status/sys27.xFunc?branchName=master)](https://exit.visualstudio.com/xFunc/_build/latest?definitionId=4&branchName=master) [![codecov](https://codecov.io/gh/sys27/xFunc/branch/master/graph/badge.svg)](https://codecov.io/gh/sys27/xFunc)
Dev: [![Build Status](https://exit.visualstudio.com/xFunc/_apis/build/status/sys27.xFunc?branchName=dev)](https://exit.visualstudio.com/xFunc/_build/latest?definitionId=4&branchName=dev) [![codecov](https://codecov.io/gh/sys27/xFunc/branch/dev/graph/badge.svg)](https://codecov.io/gh/sys27/xFunc)
Master: [![Build Status](https://dev.azure.com/exit/xFunc/_apis/build/status/sys27.xFunc?branchName=master)](https://exit.visualstudio.com/xFunc/_build/latest?definitionId=4&branchName=master) [![codecov](https://codecov.io/gh/sys27/xFunc/branch/master/graph/badge.svg)](https://codecov.io/gh/sys27/xFunc)
Dev: [![Build Status](https://dev.azure.com/exit/xFunc/_apis/build/status/sys27.xFunc?branchName=dev)](https://exit.visualstudio.com/xFunc/_build/latest?definitionId=4&branchName=dev) [![codecov](https://codecov.io/gh/sys27/xFunc/branch/dev/graph/badge.svg)](https://codecov.io/gh/sys27/xFunc)
xFunc.Maths: [![NuGet](https://img.shields.io/nuget/v/xFunc.Maths.svg)](https://www.nuget.org/packages/xFunc.Maths) [![Downloads](https://img.shields.io/nuget/dt/xFunc.Maths.svg)](https://www.nuget.org/packages/xFunc.Maths)
xFunc.DotnetTool: [![NuGet](https://img.shields.io/nuget/v/xFunc.DotnetTool.svg)](https://www.nuget.org/packages/xFunc.DotnetTool)

Expand Down Expand Up @@ -51,7 +51,7 @@ _Note: The `Parse` method won't simplify expression automatically, it will retur

**Solve:**

This method will parse string expression (like `Parse` method) and then calculate it (returns object which implements `IResult` interface).
This method parses string expression (like `Parse` method) and then calculates it (returns object which implements `IResult` interface).

There is two overloads of this method (common and generic). The common returns just `IResult` (you can access result by `Result` property). The generic allows to return specific implementation of `IResult` (eg. `NumberResult`).

Expand All @@ -74,7 +74,7 @@ processor.Solve("x := 10");
processor.Parameters.Variables.Add("x", 10);
```

_Note: The `Solve` method automatically simplify expression, to control this behavior you can use `simplify` argument. It's useful for differentiation, because it will eliminate unnecessary expression nodes._
_Note: The `Solve` method automatically simplifies expression, to control this behavior you can use `simplify` argument. It's useful for differentiation, because it will eliminate unnecessary expression nodes._

**Simplify:**

Expand Down Expand Up @@ -139,7 +139,3 @@ xFunc is released under MIT License.
[ReportGenerator](https://github.com/danielpalme/ReportGenerator)
[xUnit](https://github.com/xunit/xunit)
[Moq](https://github.com/moq/moq4)

## More:

* [NuGet](https://nuget.org/packages?q=xFunc)
4 changes: 3 additions & 1 deletion xFunc.Maths/xFunc.Maths.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ https://github.com/sys27/xFunc/wiki/Breaking-Changes</PackageReleaseNotes>
<AnalysisLevel>latest</AnalysisLevel>
<EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
<ImplicitUsings>enable</ImplicitUsings>
<PackageReadmeFile>README.md</PackageReadmeFile>
</PropertyGroup>

<ItemGroup>
Expand Down Expand Up @@ -63,7 +64,7 @@ https://github.com/sys27/xFunc/wiki/Breaking-Changes</PackageReleaseNotes>
<PropertyGroup Condition="'$(Configuration)' == 'Release'">
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
</PropertyGroup>

<PropertyGroup Condition="'$(TF_BUILD)' == 'true'">
<ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
<EmbedUntrackedSources>true</EmbedUntrackedSources>
Expand All @@ -75,6 +76,7 @@ https://github.com/sys27/xFunc/wiki/Breaking-Changes</PackageReleaseNotes>
</None>
<None Include="..\xFunc.png" Pack="true" PackagePath="" />
<AdditionalFiles Include="..\.stylecop.json" Link=".stylecop.json" />
<None Include="..\README.md" Pack="true" PackagePath="" />
</ItemGroup>

<ItemGroup>
Expand Down

0 comments on commit 7460875

Please sign in to comment.