Skip to content

Latest commit

 

History

History
192 lines (141 loc) · 5.6 KB

README.md

File metadata and controls

192 lines (141 loc) · 5.6 KB
Raw

Using PeyrSharp GitHub contributors GitHub issues GitHub GitHub release (latest SemVer) Nuget


Logo

PeyrSharp

A C# library designed to make developers' job easier.
View documentation »
Report Bug · Request Feature · NuGet

Introduction

PeyrSharp is a C# written library designed to make developers' life easier. We've all written code that we wish we hadn't. PeyrSharp is here to respond to this need; by implementing useful methods in various domains: Mathematics, Web/HTTP requests, unit converters, extensions, environment-related operations, and more!

Modules

PeyrSharp is divided in multiple packages:

PeyrSharp, the main package, that contains all of the followings:

PeyrSharp.Core, the basic methods and features of C#
  • Maths
  • Password
  • Guid
  • Converters
  • Internet
  • Crypt
  • XmlHelper
  • JsonHelper
  • StatusInfo
PeyrSharp.Env, methods related to the file system and to the current execution environment.
  • FileSys
  • Logger
  • System
  • Update
  • UwpApp
PeyrSharp.Enums, all enumerations used by PeyrSharp
  • WindowsVersion
  • TimeUnits
  • SystemThemes
  • OperatingSystems
  • StorageUnits
  • ControlAlignment
  • PasswordPresets
  • PasswordStrength
PeyrSharp.Exceptions, all exceptions used by PeyrSharp
  • RGBInvalidValueException
  • HEXInvalidValueException
  • InvalidGuidLengthException
PeyrSharp.Extensions, extension methods, that extends basic types, such as string, int, double or arrays (T[]).
  • String
  • Int
  • Double
  • Array (T[])
PeyrSharp.UiHelpers, methods related to Windows Forms or to the Windows Presentation Framework (WPF).
  • WinForms
  • Screen
  • WindowHelpers
  • WindowInfo
  • WPF

Compatibility

Platforms

Some modules of PeyrSharp are targeting features only available in specific operating systems. Thus, some packages aren't available on all platforms.

Package/Platform Windows macOS Linux + others
Core ✅ ✅ ✅
Env ✅ ⚠️ ⚠️
Enums ✅ ✅ ✅
Exceptions ✅ ✅ ✅
Extensions ✅ ✅ ✅
UiHelpers ✅ ❌ ❌

Caption:

  • ✅ Full Support
  • ⚠️ Partial Support
  • ❌ Unsupported platform

Frameworks

PeyrSharp is available in the following frameworks

  • .NET 6
  • .NET 7
  • .NET 8

Note: .NET Framework, .NET Core and .NET 5 are not targeted by PeyrSharp.

Documentation

Website

PeyrSharp has an official website where you can find its documentation.

Branches

There are two branches:

Name Release Description
main GitHub release (latest by date) Stable versions
vNext GitHub release (latest by date including pre-releases) Next version of PeyrSharp (unstable)
doc N/A The branch used to maintain the documentation.

Note: Other branches can also - of course - exists.

Contribute

Here's what you'll need to contribute to this project:

  • Visual Studio 2022 with:
    • .NET Desktop Development
    • Git
  • .NET
    • .NET 6 (SDK + runtime)
    • .NET 7 (SDK + runtime)
    • .NET 8 (SDK + runtime)
  • (optional) NuGet

Badge

![Using PeyrSharp](https://img.shields.io/badge/using-PeyrSharp-DD00FF?logo=nuget)

License

Project under the MIT license.