Skip to content

Commit

Permalink
adding more info to README.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
salaros committed Jul 17, 2018
1 parent 2b59095 commit 8d05d55
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion 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).
Expand Down
Binary file added assets/debugger-selection.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/properties-add-in-data.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8d05d55

Please sign in to comment.