Skip to content

Commit cea055a

Browse files
authored
Update README.md
updated minor formatting changes and typos
1 parent 00a5696 commit cea055a

File tree

1 file changed

+39
-39
lines changed

1 file changed

+39
-39
lines changed

README.md

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -2,82 +2,82 @@
22

33
# What is CodeFactory?
44

5-
CodeFactory is real time software delivery tool that natively runs inside of Visual Studio. The focus of CodeFactory is to increase the delivery velocity of building new applications or the uplift/refactor of projects to other technologies.
5+
CodeFactory is real time software delivery tool that runs natively inside of Visual Studio. The focus of CodeFactory is to increase the delivery velocity of building new applications and/or uplift/refactor projects to other technologies.
66

77
## Automation of Construction Delivery Patterns
8-
One of the core features of CodeFactory is to use your application source code as a data model. This is a similar concept to ORM mapping based tools.
8+
One of the core features of CodeFactory is its use of your application source code as a data model. This is a similar concept to ORM mapping based tools.
99

10-
This allows for the implementation of development patterns which can then auto generate common application code that developers would otherwise have to build by hand. The following common usage scenarios showcase this concept. These are by no means the only scenarios in available.
10+
This allows for the implementation of development patterns which can then auto-generate common application code which developers would otherwise have to build by hand. The following common usage scenarios are good examples of this concept, although many other scenarios are feasible.
1111

12-
- Adding/Creating Bounds checking in methods
12+
- Adding/Creating bounds checking within methods
1313
- Implementation of exception handling logic
1414
- Implementation of standard logging
1515
- Automation of dependency injection
16-
- Auto creation of different application layers based on common data models that can now be identified directly from application source code
17-
- Auto generation of data access layers based on different technologies that fit the need of a target delivery pattern
18-
- Auto generation of validation logic based on application source code data
19-
- Auto generation and mapping of logic between service technolgoies and consumers
16+
- Auto-creation of different application layers, based on common data models, that can now be identified directly from application source code
17+
- Auto-generation of data access layers, based on different technologies, that fit the needs of a target delivery pattern
18+
- Auto-generation of validation logic based on application source code data
19+
- Auto-generation and logic mapping between service technologies and consumers
2020

2121
## Automation of Technology Transformation
22-
Due to the way in which the CodeFactory SDK was designed - the tooling is very helpful in transforming existing functionality of an application to a new technology implementation. The following are common usage scenarios for technology transformation - but like the Construction Patterns above are not the only scenarios for usage.
22+
Due to the way in which the CodeFactory SDK was designed - the tooling is very helpful in transforming existing functionality of an application to a new technology implementation. The following are common usage scenarios for technology transformation, but like the Construction Delivery Patterns described above, are not the only scenarios for usage.
2323

24-
- Read ORM based data classes and transform into POCO's or to other ORM based implementations
24+
- Read ORM-based data classes and transform into POCO's or to other ORM based implementations
2525
- Read data classes and generate interface definitions for all classes
2626
- Read markup languages and use adapters to transform markup from one implementation into another (Example WebForms to Blazor)
27-
- Read markup languages and update UI implmentation frameworks from one implementation to another (Example Modern UI to BootStrap)
27+
- Read markup languages and update UI implementation frameworks from one implementation to another (Example Modern UI to BootStrap)
2828
- Lift and shift of application logic from one platform to another (Example map logic from .net framework to .net standard)
29-
- Migration Mapping of logic from one system to another (Example using UI dialogs to select where logic comes from and where it goes in a new system)
29+
- Migration Mapping of logic from one system to another (Example using UI dialogs to select where logic comes from and where it belongs in a new system)
3030

3131
## Designed for Different Delivery Approaches
32-
CodeFactory directly integrates into the Solution Explorer in Visual Studio. This provides flexibility to the delivery team on when to use automation and how that automation should be triggered. The following are a few examples, much like the others above these are not the only approaches that can be taken.
32+
CodeFactory directly integrates into the Solution Explorer within Visual Studio. This provides flexibility to the delivery team on when to use automation and how that automation should be triggered. The following are a few examples, much like the others above, these are not the only approaches that can be taken.
3333

3434
### Contract Driven Approach
3535
Interfaces are defined and automation triggers when interfaces need to be implemented. Allowing for a interface based design of the system and the core shell of the entire delivery driven by interface implementations.
3636

3737
### UI Driven Approach
38-
User Interface dialogs are defined and triggered as a part of an automation command and questions are asked which generates the impementation of new or uplift of application logic.
38+
User Interface dialogs are defined and triggered as a part of an automation command and questions are asked which generates the implementation of new or uplift of application logic.
3939

4040
### Event Driven Approach
41-
Changes in markup files or .net application code files like c# will trigger the option to execute automation logic to complete the implementation of logic.
41+
Changes in markup files or .NET application code files like C# will trigger the option to execute automation logic to complete the implementation of logic.
4242

4343
### Rebuild Approach
44-
Logic is run that will rebuild the definition of a target artifact. This is a common approach with ORM based tools.
44+
Logic is run which will rebuild the definition of a target artifact. This is a common approach with ORM based tools.
4545

4646
### Hybrid Approach
47-
This is the most common which uses a number of the above approaches together to meet a development teams delivery needs.
47+
This is the most common use case, which uses a number of the above approaches together to meet a development teams specific delivery needs.
4848

4949
## Zero Touch Delivery Tool
50-
CodeFactory runs inside of visual studio itself and it acts more like a behind the scenes compiler. CodeFactory is a design time tool and has no application runtime capabilties. This means there is no application libraries or technologies that have to be included inside the application you are delivering. Any artificates that are generated by CodeFactory appear to be standard developer hand written code.
50+
CodeFactory runs inside of the Visual Studio IDE itself, and acts more like a behind the scenes compiler. CodeFactory is a design-time tool and has no application runtime capabilities. This means there are no application libraries or technologies that have to be included inside the application you are delivering. Any artificates that are generated by CodeFactory appear to be standard developer hand-written code.
5151

52-
## Designed to Build Team Customized Delivery
53-
CodeFactory is a team delivery tool, which means there is no one size fits all delivery process. Its a SDK style platform that simplifies the design of automation to be taken advantage of by delivery teams.
52+
## Designed to Build Team-Customized Delivery
53+
CodeFactory is a team delivery tool, which means there is no one-size-fits-all delivery process. Its a SDK style platform that simplifies the design of automation to be leveraged by delivery teams.
5454
CodeFactory releases a standard set of automation libraries fully implemented.
5555
The goal of these libraries is to provide standard guidance scenarios.
56-
Alot of teams will want to extend and change the guidance. Which is exactly what this tool is designed for.
56+
Many teams will want to extend and modify the guidance to match their own design preferences, which is exactly what the CodeFactory SDK is designed for.
5757

58-
The following are the core capabilities of CodeFactory
58+
The following are the core capabilities of CodeFactory:
5959

6060
### Solution and Project Management
61-
Direct access to the solution and project system hosted inside of visual studio. This will include access and partial management of the following items.
61+
Direct access to the solution and project system hosted inside of Visual Studio. This will include access and partial management of the following items:
6262

63-
- Solution
63+
- Solutions
6464
- Solution Folders
6565
- Projects
6666
- Project Folders
6767
- Project Documents
6868
- C# Source Code Files
6969

7070
### Document Management
71-
Direct access to any document that is hosted in the solution this will include the following.
71+
Direct access to any document that is hosted within the solution, which includes the following:
7272

73-
- Read of all content from any document in the solution
74-
- Replace all content in a document
75-
- Add/remove/replace content at target locations within the document
73+
- Read all content from any document within the solution
74+
- Replace any/all content within a document
75+
- Add/remove/replace content at target locations within a document
7676
- Add new documents
7777
- Remove documents
7878

7979
### C# Source Code Model Generation
80-
CodeFactory builds real time data models of C# code files. The models provide access to the following information
80+
CodeFactory builds real time data models of C# code files. These models provide access to the following information:
8181

8282
- Using statements
8383
- Namespace definitions
@@ -93,23 +93,23 @@ CodeFactory builds real time data models of C# code files. The models provide ac
9393
- Type definitions
9494
- Access to the body of classes, interfaces, structures
9595
- Access to the body of methods, properties, events
96-
- Source code management that include replace, add before, add after, delete on all member objects
97-
- Source code management that include replace, add before, add after, delete, beginning, end of all classes,structures, interfaces
96+
- Source code management that includes replace, add before, add after, delete on all member objects
97+
- Source code management that includes replace, add before, add after, delete, beginning, end of all classes,structures, interfaces
9898

9999
### Source Formatting
100-
CodeFactory provides support for formatting of source code regardless of target langauges. This includes the following
100+
CodeFactory provides support for formatting of source code regardless of target langauges, including the following:
101101

102-
- T4 integration to support the use of T4 formatting files to emite the target source code to be generated
103-
- Source formatter an internal code factory formatter that provides granular source editing
102+
- T4 integration to support the use of T4 formatting files to emit the target source code to be generated
103+
- Source formatter an internal CodeFactory formatter that provides granular source format editing
104104

105105
### User Interface Management
106-
CodeFactory integrates natively into the Visual Studio IDE. Allowing people to build their own custom dialog windows that display as native windows inside of visual studio.
106+
CodeFactory integrates natively into the Visual Studio IDE, allowing developers to build their own custom dialog windows which display as native windows inside of Visual Studio.
107107

108108

109109
## Build Using .Net Technologies for Fast Adoption
110-
CodeFactory was designed to author automation using the C# programing language. All of code factory technologies are written using .net framework libraries.
110+
CodeFactory was designed to author automation using the C# programming language. All of CodeFactory technologies are written using .NET Framework libraries.
111111

112-
(Note: This is a current limitation of the Visual Studio development environment. As Microsoft provide .net core integration into visual studio code factory will update at that time)
112+
(Note: This is a current limitation of the Visual Studio development environment. As Microsoft provide .NET Core integration into Visual Studio, CodeFactory will update at that time.)
113113

114-
CodeFactories SDK provides a common set of tools for delivery teams to quickly extend and author their own automation for application delivery.
115-
114+
CodeFactory SDK provides a common set of tools for delivery teams to quickly extend and author their own automation for application delivery.
115+

0 commit comments

Comments
 (0)