Skip to content

Commit 85ef1d6

Browse files
authored
Update CreateProject.md
1 parent 0dfd891 commit 85ef1d6

File tree

1 file changed

+27
-27
lines changed
  • src/CodeFactoryVisualStudio/Documentation/guidance/howto/CreateProject

1 file changed

+27
-27
lines changed

src/CodeFactoryVisualStudio/Documentation/guidance/howto/CreateProject/CreateProject.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,59 +2,59 @@
22
The first step will be to create a project and register our first command.
33

44
## Background
5-
The following is important background information on CodeFatory itself.
5+
The following is important background information on CodeFactory itself.
66
This will help you understand the default startup behavior the first time you create a CodeFactory project.
77

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.
1212
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.
1414

1515
### CodeFactory Packager
1616
A CodeFactory commands project is the main execution point for all CodeFactory automation.
1717
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.
1919

2020
If no commands are defined in the project this utiltity will output a error saying the package could not be built.
2121
This error will go away once the first command is added to the project.
2222

2323

24-
## Walk through 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:
2626

2727
1. Start Visual Studio 2019
2828
___
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".
3030
![](Images/StartWindowCreateProject.png)
3131

3232
Or you can start the same process if you dont use the start up window.
3333
- Click the File menu
3434
- From the context menu select New
35-
- From the sub context menu select Project
35+
- From the sub-context menu select Project
3636

3737
![](Images/FileNewProject.png)
3838
___
39-
3. From the Create a new project window do the following
39+
3. From the "Create a new project" window do the following:
4040

4141
![](Images/SelectCommandLibraryProject.png)
4242

4343
- 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"
4646
___
47-
4. From the Configure you new project do the following
47+
4. From the "Configure your new project" window do the following:
4848

4949
![](Images/ConfigureProject.png)
5050

51-
- In the project name box type DisplayProjectCommands
51+
- In the "project name" box type "DisplayProjectCommands"
5252
- Click Create
5353
___
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.
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.
5555

5656
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.
5858
The following structure is prescriptive only.
5959
You can create any folder structure you wish for your automation.
6060

@@ -63,17 +63,17 @@ You can create any folder structure you wish for your automation.
6363
- The Project folder is where project commands are created and stored
6464
- The Dialog folder is for placement of user interface dialogs you created.
6565
- 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.
6767
___
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:
6969

7070
![](Images/SolutionExplorerProjectNewItemAdd.png)
7171

7272
- Right click on the project folder in solution explorer
7373
- From the context menu select Add
7474
- From the sub context menu select New Item...
7575
___
76-
7. From the Add New Item Dialog Window do the following.
76+
7. From the Add New Item Dialog Window do the following:
7777

7878
![](Images/AddProjectCommandDialog.png)
7979

@@ -86,21 +86,21 @@ ___
8686

8787
![](Images/VisualStudioErrorDialogCodeFactory.png)
8888

89-
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.
9191
___
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.
9393

9494
![](Images/CodeFactoryReferenceMissingError.png)
9595
___
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:
9797

9898
![](Images/BuildSolution.png)
9999

100100
- From the top navigation bar click on Build
101101
- From the context menu click Build Solution
102102
___
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.
104104

105105
You will now see the CodeFactorySDK reference in the project.
106106

@@ -120,4 +120,4 @@ In the next section we will build the logic to read information about a project
120120
## Return To Create Project Guidance
121121
The link below will take you back to the create project guidance.
122122

123-
[Create Project Guidance](Overview.md)
123+
[Create Project Guidance](Overview.md)

0 commit comments

Comments
 (0)