Codebase
Navigate the Codebase using the tree view. Use the filters to highlight where various files are grouped to aid understanding.
Getting Started Commands
Project Structure
Below is a short description of the key directories of the project to aid you when understanding where key files are located.
.editorconfig - This file defines coding standards to be used across all supported text editors.
.gitignore - This file lists the files and directories that Git should ignore.
.vscode/ - This directory contains Visual Studio Code specific settings and configurations.
assets/ - This directory contains various image files used for the project's logo in different sizes and formats.
Directory.Build.props - This file contains common properties for all projects in the solution.
LICENSE - This file contains the license agreement for the project.
README.md - This file provides an overview of the project, its usage, and other relevant information.
samples/ - This directory contains example projects demonstrating the usage of StringlyTyped library.
src/ - This directory contains the source code of the StringlyTyped library.
StringlyTyped.sln - This file is the solution file for Visual Studio, containing multiple projects within the solution.
tests/ - This directory contains unit tests for the StringlyTyped library. It includes benchmark tests and small tests.
Entrypoints
Below are files we identified as entrypoints for to the codebase. This is where the application starts and a good place to start when learning.
Path: /samples/StringlyTyped.Examples/Program.cs - This file serves as the entry point for the examples of the StringlyTyped project. It demonstrates the usage of the stringly-typed library in various scenarios, providing a practical guide for developers.
Path: /tests/StringlyTyped.Benchmarks/Program.cs - This file is the entry point for the benchmark tests of the StringlyTyped project. It contains performance tests to measure the efficiency of the stringly-typed library compared to traditional string handling methods in C#.
