Skip to content

Commit 141a12c

Browse files
authored
Merge pull request #3 from CodeFactoryLLC/DocumentUpdates
Edited/Updated the readme.md file
2 parents e2cdf6c + 46727eb commit 141a12c

File tree

1 file changed

+31
-1
lines changed

1 file changed

+31
-1
lines changed

README.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,32 @@
11
# CodeFactory.Formatting.CSharp
2-
Open source project that provides extended formatting for C# code output when working with CodeFactory automation.
2+
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.
3+
4+
## New to CodeFactory?
5+
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.
6+
7+
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/).
8+
9+
## Core purpose of the project
10+
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:
11+
- C# Lanuguage
12+
- Attribute helpers
13+
- Class helpers
14+
- Enum helpers
15+
- Event helpers
16+
- Field helpers
17+
- Generic Parameter helpers
18+
- Interface helpers
19+
- Method helpers
20+
- Parameter default value helpers
21+
- Parameter helpers
22+
- Property helpers
23+
- Security helpers
24+
- SourceCode Formatter
25+
- Structure helpers
26+
- Type helpers
27+
- Documentation helpers
28+
- Namespace manager
29+
30+
31+
## Known Limitations of this project
32+
- Currently only has formatters for the .NET C# language

0 commit comments

Comments
 (0)