You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/CodeFactoryVisualStudio/Documentation/guidance/howto/CreateProject/CreateProject.md
+27-27Lines changed: 27 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,59 +2,59 @@
2
2
The first step will be to create a project and register our first command.
3
3
4
4
## Background
5
-
The following is important background information on CodeFatory itself.
5
+
The following is important background information on CodeFactory itself.
6
6
This will help you understand the default startup behavior the first time you create a CodeFactory project.
7
7
8
-
### Nuget
9
-
CodeFactory was designed to load the target versions of the SDK libraries directly from Nuget.
10
-
The way that this is accomplished is by adding direct project references to the target version hosted on nuget.
11
-
With the legacy project system used to host .Net framework it does not automatically pull down these nuget packages when you load the project for the first time.
8
+
### NuGet
9
+
CodeFactory was designed to load the target versions of the SDK libraries directly from NuGet.
10
+
The way that this is accomplished is by adding direct project references to the target version hosted on NuGet.
11
+
With the legacy project system used to host .Net framework it does not automatically pull down these NuGet packages when you load the project for the first time.
12
12
So if any CodeFactory project items are added you will get a number of errors related to the libraries not being loaded.
13
-
The Nuget packages will automatically be pulled down the first time you do a build of the project itself, these errors will then go away.
13
+
The NuGet packages will automatically be pulled down the first time you do a build (Ctrl-Shift-B) of the project itself, these errors will then go away.
14
14
15
15
### CodeFactory Packager
16
16
A CodeFactory commands project is the main execution point for all CodeFactory automation.
17
17
This project will automatically execute a command line utility after the compile of the project has completed.
18
-
The CFXPackager utility is responsible for building the CFX file that is used to run codefactory automation.
18
+
The CFXPackager utility is responsible for building the CFX file that is used to run CodeFactory automation.
19
19
20
20
If no commands are defined in the project this utiltity will output a error saying the package could not be built.
21
21
This error will go away once the first command is added to the project.
22
22
23
23
24
-
## Walkthrough Steps
25
-
The following is the walk through for creating the project and make sure you can successfully compile the code factory project.
24
+
## Walk-through Steps
25
+
Follow these steps to successfully create and compile your CodeFactory project:
26
26
27
27
1. Start Visual Studio 2019
28
28
___
29
-
2. From the What would you like to do? window click Create a new project
29
+
2. From the "What would you like to do?" window click "Create a new project".
30
30

31
31
32
32
Or you can start the same process if you dont use the start up window.
33
33
- Click the File menu
34
34
- From the context menu select New
35
-
- From the subcontext menu select Project
35
+
- From the sub-context menu select Project
36
36
37
37

38
38
___
39
-
3. From the Create a new project window do the following
39
+
3. From the "Create a new project" window do the following:
40
40
41
41

42
42
43
43
- In the search box type CodeFactory
44
-
- From The list of projects select CodeFactory - Commands Library
45
-
- Click Next
44
+
- From The list of projects select "CodeFactory - Commands Library"
45
+
- Click "Next"
46
46
___
47
-
4. From the Configure you new projectdo the following
47
+
4. From the "Configure your new project" window do the following:
48
48
49
49

50
50
51
-
- In the project name box type DisplayProjectCommands
51
+
- In the "project name" box type "DisplayProjectCommands"
52
52
- Click Create
53
53
___
54
-
5. Once the solution and project has been created you will see the project and default folder structure. I have expanded the Project folder to show you the subfolders.
54
+
5. Once the solution and project has been created you will see the project and default folder structure. I have expanded the Project folder to show you the sub-folders.
55
55
56
56
The following is a brief overview of the goal for each folder.
57
-
Important note each explorer command has its own folder.
57
+
Important note: each Explorer Command has its own folder.
58
58
The following structure is prescriptive only.
59
59
You can create any folder structure you wish for your automation.
60
60
@@ -63,17 +63,17 @@ You can create any folder structure you wish for your automation.
63
63
- The Project folder is where project commands are created and stored
64
64
- The Dialog folder is for placement of user interface dialogs you created.
65
65
- The Logic folder is where you add logic that can be reused across multiple project commands
66
-
- The Template folder is where you add T4 template that as used by project commands.
66
+
- The Template folder is where you add T4 template that are used by project commands.
67
67
___
68
-
6. Next we will add a solution explorer project command to the project. Do the following steps.
68
+
6. Next we will add a solution explorer project command to the project. Do the following steps:
69
69
70
70

71
71
72
72
- Right click on the project folder in solution explorer
73
73
- From the context menu select Add
74
74
- From the sub context menu select New Item...
75
75
___
76
-
7. From the Add New Item Dialog Window do the following.
76
+
7. From the Add New Item Dialog Window do the following:
This error occurs because the CodeFactory SDK nuget packages have not been downloaded into the project yet.
90
-
Click Ok to continue.
89
+
This error occurs because the CodeFactory SDK NuGet packages have not been downloaded into the project yet.
90
+
This is normal. Click Ok to continue.
91
91
___
92
-
9. The command code file will display in the IDE and a number of syntax errors will appear. This is occuring since we have not pulled down the SDK through nuget yet.
92
+
9. The command code file will display in the IDE and a number of syntax errors will appear. This is occuring since we have not pulled down the SDK through NuGet yet.
93
93
94
94

95
95
___
96
-
10. We will then build the solution this will trigger the pull of the nuget packages. Do the following.
96
+
10. We will then Build the solution which will trigger the pull of the NuGet packages. Do the following:
97
97
98
98

99
99
100
100
- From the top navigation bar click on Build
101
101
- From the context menu click Build Solution
102
102
___
103
-
11. Once the build has completed it will have downloaded and installed the nuget packages into the project.
103
+
11. Once the build has completed it will have downloaded and installed the NuGet packages into the project.
104
104
105
105
You will now see the CodeFactorySDK reference in the project.
106
106
@@ -120,4 +120,4 @@ In the next section we will build the logic to read information about a project
120
120
## Return To Create Project Guidance
121
121
The link below will take you back to the create project guidance.
0 commit comments