Skip to content

Edited/Updated the readme.md file #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bfencken merged 1 commit into from
Oct 7, 2020
Merged

Edited/Updated the readme.md file #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 31 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,32 @@
# CodeFactory.Formatting.CSharp
Open source project that provides extended formatting for C# code output when working with CodeFactory automation.
This open source project is an that provides extended formatting for C# code output - intended for use by a CodeFactory automation template author. The final output is published as a Nuget Package which makes available all of the formatting helpers to implementing authors.

## New to CodeFactory?
In the simplest terms, CodeFactory is a real time software factory that is triggered from inside Visual Studio during the design and construction of software. CodeFactory allows for development staff to automate repetitive development tasks that take up developer�s time.

Please see the following link for further information and guidance about the [CodeFactory Runtime](https://github.com/CodeFactoryLLC/CodeFactory) or the [CodeFactory SDK](https://www.nuget.org/packages/CodeFactorySDK/).

## Core purpose of the project
This project holds a series of formatting helpers that are organized by language, each of which helps to ease in which an automation template author can emit code artifacts back into a project/solution. Currently the project contains helpers for the following language and categories:
- C# Lanuguage
- Attribute helpers
- Class helpers
- Enum helpers
- Event helpers
- Field helpers
- Generic Parameter helpers
- Interface helpers
- Method helpers
- Parameter default value helpers
- Parameter helpers
- Property helpers
- Security helpers
- SourceCode Formatter
- Structure helpers
- Type helpers
- Documentation helpers
- Namespace manager


## Known Limitations of this project
- Currently only has formatters for the .NET C# language