Skip to content

Commit 2ed2b75

Browse files
committed
Updates to initial documentation
1 parent 1437f73 commit 2ed2b75

File tree

5 files changed

+66
-3
lines changed

5 files changed

+66
-3
lines changed

AddProjectItem.png

52.5 KB
Loading

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2023 CodeFactoryLLC
3+
Copyright (c) 2023 CodeFactory, LLC.
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

NewProject.png

69.8 KB
Loading

NewProjectFramework48.png

31 KB
Loading

README.md

Lines changed: 65 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,65 @@
1-
# CodeFactoryForWindows
2-
CodeFactory SDK for Visual Studio for Windows
1+
# CodeFactory SDK for Visual Studio for Windows
2+
3+
This project hosts the full SDK that is used by CodeFactory for Windows.
4+
5+
## Overview
6+
This repository is the offical home of version 2.0 of CodeFactory.
7+
The reason for the change is future planning for the usage of CodeFactory.
8+
In the future CodeFactory will run on multiple IDE environments.
9+
Right now we are focusing on VisualStudio for Windows.
10+
11+
The following are some future IDE's we are investing for integration.
12+
- **Microsoft Visual Studio Code**
13+
- **Jet Brains Rider**
14+
15+
## SDK Libraries
16+
The following are the new libraries and utilties that are used for building CodeFactory automation.
17+
18+
### CodeFactory.dll
19+
This is the core contracts used by all version's of CodeFactory regardless of IDE. This has been ported to **.Net Standard 2.0**.
20+
21+
### CodeFactory.WinVs.dll
22+
This is the entire implementation of the SDK related to Visual Studio for Windows. This contains a streamlined SDK over the version 1.0 of CodeFactory.
23+
The SDK has been ported to **.Net Standard 2.0**.
24+
25+
### CodeFactory.WinVs.Wpf.dll
26+
This is the user interface controls library for Visual Studio for Windows this hostes the view control.
27+
The SDK has been upgraded to **.Net Framework 4.8** requirement of Visual Studio for Windows.
28+
29+
### CodeFactory.Packager.WinVs.exe
30+
The packager is a command line utility that packages up CodeFactory automation.
31+
This utility is automatically called after the build of a CodeFactory library.
32+
The packager has been upgraded to **.Net Framework 4.8**.
33+
34+
## Updated Templates
35+
The following outlines the new templates when authoring automation with CodeFactory.
36+
Since both version 1 and 2 of CodeFactory can run side by side, templates have been updated.
37+
38+
### CodeFactory for Windows - Command Library
39+
The command library is the core library project used for creation of automation.
40+
nlike version 1.0 version there is a single library type now and no default folder structure.
41+
42+
When adding a new project you will select the **CodeFactory for Windows - CommandLibrary** project.
43+
![](./NewProject.png)
44+
45+
Important note its now a requirement to use **.Net Framework 4.8** when creating a command library.
46+
47+
![](./NewProjectFramework48.png)
48+
49+
### CodeFactory Command Templates
50+
The solution explorer and IDE commands are still still avaliable in CodeFactory for Windows.
51+
52+
They are now accessible under the category of **CodeFactoryWindows**.
53+
![](./AddProjectItem.png)
54+
55+
#### User Control Change
56+
The **VsUserControl** has been replaces with the **ViewUserControl**.
57+
58+
This includes the following changes.
59+
- Have changed the title property to just **Title**
60+
61+
Future changes coming soon.
62+
- Integration of Visual Studio themes.
63+
64+
#### Removal of T4
65+
The **T4** functionality has been removed in version 2.0. The **SourceFormatter** replaces the needs for T4.

0 commit comments

Comments
 (0)