Skip to content

Commit 7bd92e4

Browse files
committed
[Docs] Update and fix inconsistencies in MsBuild-Sdk, Templates, and additional guides.
1 parent 0e3fed1 commit 7bd92e4

File tree

5 files changed

+17
-14
lines changed

5 files changed

+17
-14
lines changed

docs/Installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ If you don't have it, you can find the latest version here: https://dotnet.micro
88

99
The templates are supplied as a Nuget package https://www.nuget.org/packages/Nice3point.Revit.Templates
1010

11-
To install it, open terminal, paste the command and press **Enter**:
11+
To install it, open the Terminal, paste the command and press **Enter**:
1212

1313
```shell
1414
dotnet new install Nice3point.Revit.Templates

docs/Managing-API-compatibility.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Example:
103103
> [!IMPORTANT]
104104
> Edit the `.csproj` file only manually, IDEs often break configurations.
105105
106-
Revit MSBuild SDK automatically sets the required `TargetFramework` based on the `RevitVersion`, extracted from the solution configuration name.
106+
Revit [MSBuild SDK](https://www.nuget.org/packages/Nice3point.Revit.Sdk) automatically sets the required `TargetFramework` based on the `RevitVersion`, extracted from the solution configuration name.
107107

108108
If you need to add support for an unreleased or unsupported version of Revit that the SDK doesn't yet know about, you can add a conditional block to specify the `TargetFramework` manually:
109109

docs/MsBuild-Sdk.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -285,11 +285,14 @@ To configure a default debug profile that launches the target Revit version, ena
285285
</PropertyGroup>
286286
```
287287

288-
This sets additional properties (only when values are not already specified):
288+
If you want to run Revit in a different language or installed in a different directory, also override some properties.:
289289

290-
- `StartAction=Program`
291-
- `StartProgram=C:\Program Files\Autodesk\Revit $(RevitVersion)\Revit.exe`
292-
- `StartArguments=/language ENG`
290+
```xml
291+
<PropertyGroup>
292+
<StartProgram>C:\Program Files\Autodesk\Revit $(RevitVersion)\Revit.exe</StartProgram>
293+
<StartArguments>/language ENG</StartArguments>
294+
</PropertyGroup>
295+
```
293296

294297
## Configuration
295298

docs/Step‐by‐step-Guide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ To create a new project, click **New Solution** in Rider or **Create a new Proje
4343

4444
1. Select the desired [template](Templates.md), such as Revit Addin for a single-project add-in.
4545
2. Name your project and choose the directory.
46-
3. Choose additional settings, such as whether to include WPF. If unsure, stick with the default settings.
46+
3. Choose additional settings, such as whether to include WPF. If unsure, keep the default settings.
4747

4848
![image](https://github.com/user-attachments/assets/0dbfe226-ad35-4887-9c06-b584a4332dfa)
4949

@@ -71,7 +71,7 @@ Debugging is pretty simple, without any additional setup. To debug:
7171
## Creating Additional Modules
7272

7373
For larger projects, a single-project solution may not be sufficient.
74-
Splitting your plugin into multiple modules is a best practice when managing unrelated processes.
74+
Splitting your plugin into multiple modules is the best practice when managing unrelated processes.
7575

7676
To add another project to your solution, we will [use](Templates.md) the **Revit AddIn Module** and **Revit AddIn Application** templates.
7777

@@ -131,7 +131,7 @@ Follow the steps from previous sections to add projects to this solution:
131131
Let's customize the build system:
132132
1. In the **build** project, you will find frequently used configuration files, right now we need **appsettings.json**.
133133
2. Update the **BundleOptions** section if you plan to publish your application to the Autodesk Store.
134-
3. The build system automatically finds all projects in the **source** folder, so no additional mapping is required.
134+
3. If your add-im name differs from the solution name, you will also need to replace the generated by [Sourcy](https://github.com/thomhurst/Sourcy) properties pointing to the project.
135135

136136
![image](https://github.com/user-attachments/assets/80bc14c9-d10a-4d4a-8360-70f3d5aff242)
137137

docs/Templates.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Suitable for enterprise development and developers who need a ready-made project
6666
This template contains:
6767

6868
- `ModularPipelines` build system
69-
- Installer project, that generates an .msi package
69+
- Installer project, that generates an **.msi** package
7070
- Auxiliary files such as `.gitignore`, `Changelog.md` which are usually created in each solution. `Readme.md` contains documentation and instructions for building the project.
7171
- CI\CD setup
7272
- JetBrains Rider `Run configurations`
@@ -76,17 +76,17 @@ This template contains:
7676
7777
> [!TIP]
7878
> The solution template should be used before the project templates (if you need it).
79-
And you have to create all plugins in produced solution, in the `source` folder.
79+
> And you have to create all plugins in the produced solution, in the `source` folder.
8080
8181
### ModularPipelines
8282

83-
ModularPipelines is used to build a project for various configurations. In this case, for all specified Revit versions. It also allows you to automate other secondary processes, create an
84-
installer, generate a changelog, etc.
83+
ModularPipelines is used to build a project for various configurations. In this case, for all specified Revit versions.
84+
It also allows you to automate other secondary processes, create an installer, generate a changelog, etc.
8585

8686
More details about ModularPipelines [here](https://github.com/thomhurst/ModularPipelines).
8787

8888
> [!NOTE]
89-
> You don't need to use the build system to debug the project, it is only necessary for the publishing release.
89+
> You don't need to use the build system for the add-ins directly, it's only needs for publishing Releases.
9090
9191
### Installer
9292

0 commit comments

Comments
 (0)