Skip to content

Commit dacf5e5

Browse files
Dennis Doomendennisdoomen
authored andcommitted
Updates to the read-me
1 parent 99fe70f commit dacf5e5

File tree

2 files changed

+29
-23
lines changed

2 files changed

+29
-23
lines changed

CONTRIBUTING.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,6 @@ Ideally, a bug report should contain the following information:
2323
* Information on the environment: nuget version, .NET version, etc.
2424
* Additional information, e.g. is it a regression from previous versions? are there any known workarounds?
2525

26-
When ready to submit a bug report, please use the [Bug Report issue template](https://github.com/your-user-name/my-package/issues/new?labels=&template=01_bug_report.yml).
27-
2826
#### Why are Minimal Reproductions Important?
2927

3028
A reproduction lets maintainers verify the presence of a bug, and diagnose the issue using a debugger. A _minimal_ reproduction is the smallest possible console application demonstrating that bug. Minimal reproductions are generally preferable since they:

README.md

Lines changed: 29 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
[![open issues](https://img.shields.io/github/issues/dennisdoomen/Pathy)](https://github.com/dennisdoomen/Pathy/issues)
2121
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com)
2222
![](https://img.shields.io/badge/release%20strategy-githubflow-orange.svg)
23-
![Static Badge](https://img.shields.io/badge/4.7%2C_6.0%2C_netstandard2.0%2C_netstandard2.1-dummy?label=dotnet&color=%235027d5)
23+
![Static Badge](https://img.shields.io/badge/4.7%2C_8.0%2C_netstandard2.0%2C_netstandard2.1-dummy?label=dotnet&color=%235027d5)
2424

2525

2626

@@ -39,20 +39,32 @@
3939

4040
### What's this?
4141

42-
Add stuff like:
43-
* Pathy offers
44-
* what .NET, C# other versions of dependencies it supports
42+
Pathy is a tiny source-only library that will allow you to build file and directory paths by chaining together strings like `"c:"`, `"dir1"`, `"dir2"` using
43+
44+
`ChainablePath.New() / "c:" / "dir1" / "dir2"`.
45+
46+
It was heavily inspired by the best build pipeline framework available in the .NET space, [Nuke](https://nuke.build/). Nuke has supported these concepts for many years, but I needed this capability outside build pipelines.
47+
48+
It doesn't have any dependencies and runs on .NET 4.7, .NET 8, as well as frameworks supporting .NET Standard 2.0 and 2.1.
4549

4650
### What's so special about that?
4751

48-
* What makes it different from other libraries?
49-
* Why did you create it.
50-
* What problem does it solve?
51-
* Mention that it is a source-only package, which just adds a C# file and doesn't create binary dependencies
52+
It makes those chained calls to `Path.Combine` a thing from the past and hides the ugliness of dealing with (trailing) slashes.
53+
54+
It ships as a source-only package, which means you can use it in your own libraries and projects, without incurring any dependency pain on your consuming projects.
55+
56+
The core Pathy package does not have any dependencies, and I purposely moved the [globbing](https://learn.microsoft.com/en-us/dotnet/core/extensions/file-globbing#pattern-formats) functionality into a separate package as it depends on `Microsoft.Extensions.FileSystemGlobbing`.
5257

5358
### Who created this?
54-
* Something about you, your company, your team, etc.
55-
* How to contact you like LinkedIn, Twitter, Bluesky, Mastodon, email, etc.
59+
My name is Dennis Doomen and I'm a Microsoft MVP and Principal Consultant at [Aviva Solutions](https://avivasolutions.nl/) with 28 years of experience under my belt. As a software architect and/or lead developer, I specialize in designing full-stack enterprise solutions based on .NET as well as providing coaching on all aspects of designing, building, deploying and maintaining software systems. I'm the author of several open-source projects such as [Fluent Assertions](https://www.fluentassertions.com), [Reflectify](https://github.com/dennisdoomen/reflectify), [Liquid Projections](https://www.liquidprojections.net), and I've been maintaining [coding guidelines for C#](https://www.csharpcodingguidelines.com) since 2001.
60+
61+
Contact me through [Email](mailto:dennis.doomen@avivasolutions.nl), [Bluesky](https://bsky.app/profile/dennisdoomen.com), [Twitter/X](https://twitter.com/ddoomen) or [Mastadon](https://mastodon.social/@ddoomen)
62+
63+
## Download
64+
65+
This library is available as [a NuGet package](https://www.nuget.org/packages/Pathy) on https://nuget.org. To install it, use the following command-line:
66+
67+
`dotnet add package Pathy`
5668

5769
## How do I use it?
5870
* Code examples
@@ -62,16 +74,10 @@ Add stuff like:
6274
Some example code showing your library
6375
```
6476

65-
## Download
66-
67-
This library is available as [a NuGet package](https://www.nuget.org/packages/Pathy) on https://nuget.org. To install it, use the following command-line:
68-
69-
`dotnet add package Pathy`
70-
7177
## Building
7278

7379
To build this repository locally, you need the following:
74-
* The [.NET SDKs](https://dotnet.microsoft.com/en-us/download/visual-studio-sdks) for .NET 4.7, 6.0 and 8.0.
80+
* The [.NET SDKs](https://dotnet.microsoft.com/en-us/download/visual-studio-sdks) for .NET 4.7, 8.0.
7581
* Visual Studio, JetBrains Rider or Visual Studio Code with the C# DevKit
7682

7783
You can also build, run the unit tests and package the code using the following command-line:
@@ -105,7 +111,6 @@ This library wouldn't have been possible without the following tools, packages a
105111
* [Nuke](https://nuke.build/) - Smart automation for DevOps teams and CI/CD pipelines by [Matthias Koch](https://github.com/matkoch)
106112
* [xUnit](https://xunit.net/) - Community-focused unit testing tool for .NET by [Brad Wilson](https://github.com/bradwilson)
107113
* [Coverlet](https://github.com/coverlet-coverage/coverlet) - Cross platform code coverage for .NET by [Toni Solarin-Sodara](https://github.com/tonerdo)
108-
* [Polysharp](https://github.com/Sergio0694/PolySharp) - Generated, source-only polyfills for C# language features by [Sergio Pedri](https://github.com/Sergio0694)
109114
* [GitVersion](https://gitversion.net/) - From git log to SemVer in no time
110115
* [ReportGenerator](https://reportgenerator.io/) - Converts coverage reports by [Daniel Palme](https://github.com/danielpalme)
111116
* [StyleCopyAnalyzer](https://github.com/DotNetAnalyzers/StyleCopAnalyzers) - StyleCop rules for .NET
@@ -122,9 +127,12 @@ This library wouldn't have been possible without the following tools, packages a
122127

123128
## You may also like
124129

125-
* Your blog
126-
* Your other projects
127-
* Related projects you think are cool or interesting for the consumers of this project
130+
* [My Blog](https://www.dennisdoomen.com)
131+
* [PackageGuard](https://github.com/dennisdoomen/packageguard/) - Get a grip on your open-source packages
132+
* [Reflectify](https://github.com/dennisdoomen/reflectify) - Reflection extensions without causing dependency pains
133+
* [.NET Library Package Templates](https://github.com/dennisdoomen/dotnet-package-templates) - "dotnet new" templates for building NuGet-published multi-targeting libraries with all the bells and whistles
134+
* [FluentAssertions](https://github.com/fluentassertions/fluentassertions) - Extension methods to fluently assert the outcome of .NET tests
135+
* [C# Coding Guidelines](https://csharpcodingguidelines.com/) - Forkable coding guidelines for all C# versions
128136

129137
## License
130138
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)