Skip to content

Commit

Permalink
refactor instructions added
Browse files Browse the repository at this point in the history
  • Loading branch information
mitevpi committed Jan 27, 2020
1 parent f2791a8 commit 68a5501
Show file tree
Hide file tree
Showing 9 changed files with 16 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,16 @@ WPF Template for Revit Add-Ins including wrapped external methods for execution

### Build

Clone/download this repository and open the `.sln` at the root of the repository with Microsoft Visual Studio.
Building the solution will automatically create and copy the add-in files to the folder for Revit 2019. Upon opening
Revit 2019, there should be a tab called "Template" in Revit, with a button to launch the WPF add-in.
1. Clone/download this repository and open the `.sln` at the root of the repository with Microsoft Visual Studio.
2. Re-link references to `RevitAPI.dll` and others which may be missing.
3. Build the solution - Building the solution will automatically create and copy the add-in files to the folder for Revit 2019.
4. Open Revit - Upon opening Revit 2019, there should be a tab called "Template" in Revit, with a button to launch the WPF add-in.

### Customize

In order to use this as a starter for your application, make sure you first refactor the content in the application files (namespace, assembly name, classes, GUID, etc.)
In order to use this as a starter for your application, make sure you first refactor the content in the application files (namespace, assembly name, classes, GUID, etc.) and remove the [assets](/assets) folder in this repository.

A guide to refactoring can be found in the [docs](/docs/RefactorInstructions.md) folder.

## Documentation

Expand All @@ -26,4 +29,4 @@ Documentation is created using [Sandcastle Help File Builder](https://github.com
The documentation can be found in the [docs](/docs) folder in the root of this repository. The following documentation sources are created by [Sandcastle Help File Builder](https://github.com/EWSoftware/SHFB):

1. [`.chm`](./docs/Help/Revit%20WPF%20Template%20Documentation.chm) - This is an interactive help file which can be launched by double-clicking on any Windows machine.
2. [`index.html`] - This is the documentation compiled for web deployment. Please note that many of the supporting files needed to deploy the documentation to the web have been git-ignored due to their size and count. Make sure to compile documentation yourself using [Sandcastle Help File Builder](https://github.com/EWSoftware/SHFB) prior to trying to use/deploy the web version of the documentation.
2. [`index.html`] - This is the documentation compiled for web deployment. Please note that many of the supporting files needed to deploy the documentation to the web have been git-ignored due to their size and count. Make sure to compile documentation yourself using [Sandcastle Help File Builder](https://github.com/EWSoftware/SHFB) prior to trying to use/deploy the web version of the documentation. A preview of what this looks like can be [found here](revit-wpf-template-docs.now.sh).
Binary file added assets/refactor-instructions Page 001.png
Loading
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/refactor-instructions Page 002.png
Loading
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/refactor-instructions Page 003.png
Loading
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/refactor-instructions Page 004.png
Loading
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/refactor-instructions Page 005.png
Loading
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/refactor-instructions Page 006.png
Loading
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/refactor-instructions.pdf
Binary file not shown.
8 changes: 8 additions & 0 deletions docs/RefactorInstructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Refactor Instructions

![1](../assets/refactor-instructions%20Page%20001.png)
![2](../assets/refactor-instructions%20Page%20002.png)
![3](../assets/refactor-instructions%20Page%20003.png)
![4](../assets/refactor-instructions%20Page%20004.png)
![5](../assets/refactor-instructions%20Page%20005.png)
![6](../assets/refactor-instructions%20Page%20006.png)

0 comments on commit 68a5501

Please sign in to comment.