Getting Started

This guide will help you get started with the String Extensions library project.

Project Status

The String Extensions library is currently under development. This repository contains the project structure and documentation framework, with implementation to follow.

For Contributors

If you'd like to contribute to the development of this library:

Prerequisites

  • .NET SDK - The library will support .NET Framework 4.6.2 through .NET 10
  • A compatible IDE (Visual Studio 2022, Visual Studio 2019, VS Code, or Rider)
  • Basic knowledge of C# and .NET

Setting Up for Development

  1. Clone the repository:

    git clone https://github.com/Chris-Wolfgang/String-Extensions.git
cd String-Extensions

  2. Explore the structure:

    • /src - Source code will go here
    • /tests - Unit tests will go here
    • /benchmarks - Performance benchmarks will go here
    • /examples - Example usage will go here
    • /docs - Additional documentation

  3. Review the contribution guidelines: See CONTRIBUTING.md for details on the development workflow and coding standards.

For Future Users

Once the library is published to NuGet, you will be able to install it using:

Via NuGet Package Manager

  1. Right-click on your project in Solution Explorer
  2. Select "Manage NuGet Packages"
  3. Search for "String-Extensions"
  4. Click "Install"

Via .NET CLI

dotnet add package String-Extensions

Via Package Manager Console

Install-Package String-Extensions

Documentation Structure

  • Introduction - Project overview and goals
  • Setup - Development setup instructions
  • API Reference - API documentation (to be generated)

Getting Help

If you have questions or want to contribute:

  • Visit the GitHub Repository
  • Open an issue for bug reports or feature requests
  • Check existing issues and discussions

Next Steps

For detailed development setup instructions, see the Setup Guide.