diff --git a/README.md b/README.md index 23d149e..3519df1 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,36 @@ -Visual Studio Revit Add-in Template +Visual Studio Revit Add-in Template [![Build status](https://ci.appveyor.com/api/projects/status/vxajagat45cfeeky?svg=true)](https://ci.appveyor.com/project/salaros/vs-templates-revit-addin) =================================== ![Revit version](https://img.shields.io/badge/Revit-2014%20%E2%9E%9C%202019-blue.svg) +![Github All Releases](https://img.shields.io/github/downloads/Equipple/vs-templates-revit-addin/total.svg) +![GitHub tag](https://img.shields.io/github/tag/Equipple/vs-templates-revit-addin.svg) ![Platform](https://img.shields.io/badge/platform-Windows-red.svg) ![License](https://img.shields.io/github/license/Equipple/vs-templates-revit-addin.svg) Visual Studio C# (project) template for easy [Revit](https://en.wikipedia.org/wiki/Autodesk_Revit) add-in creation. +## Installation & Update + +Just download the latest release (.zip file) from [here](https://github.com/Equipple/vs-templates-revit-addin/releases) and copy it into your `path\to\Visual Studio 2017\templates` folder. + +Usually it's `"%USERPROFILE%\Documents\Visual Studio 2017\Templates\ProjectTemplates\Visual C#"` + +## Personalization + +Unlike other add-in template this one doesn't require constantly updating .addin file. It takes all the information from project properties: +![Project properties](assets/properties-add-in-data.png "Project properties") + +## Debug + +For your convenience in `Debug` configuration the add-in will copy its manifest to `%AppData%\Autodesk\Revit\Addins` folder with Assembly tags pointing to your compilation output folder. + +Before starting the debugger make sure you have selected the proper Revit version: +![Debugger selection](assets/debugger-selection.png "Debugger selection") + +If Revit won't start probably you have installed it to a non-default location and you have to modify [launchSettings.json](src/Properties/launchSettings.json) file. + +You could also use [launchSettings.json](src/Properties/launchSettings.json) to tweak command line parameters passed to Revit.exe file, e.g. you might want Revit to open a project template / family file for every debug session you start. + ## License This project is licensed under the terms of the [MIT License](LICENSE). diff --git a/assets/debugger-selection.png b/assets/debugger-selection.png new file mode 100644 index 0000000..d97acac Binary files /dev/null and b/assets/debugger-selection.png differ diff --git a/assets/properties-add-in-data.png b/assets/properties-add-in-data.png new file mode 100644 index 0000000..bdb8e59 Binary files /dev/null and b/assets/properties-add-in-data.png differ