Skip to content

Commit

Permalink
added info on how to make git skip locally added SchiChart license key
Browse files Browse the repository at this point in the history
  • Loading branch information
braunms committed Aug 8, 2023
1 parent 6214360 commit 48612ac
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 8 deletions.
11 changes: 9 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
## ----------------------------------------------------------------------------
## Ignore VisFroG specific files


# Ignore generated databases
*.db

#####
# In order to ignore locally added SciChart runtime license keys in /SciChartInterface/SciChartRuntimeLicenseKey.cs, call:
# $ git update-index --skip-worktree SciChartInterface/SciChartRuntimeLicenseKey.cs
#####

## ------------------------------------------------------------------------
## ----------------------------------------------------------------------------
## Ignore Visual Studio temporary files, build results, and
## files generated by popular Visual Studio add-ons.
##
Expand Down Expand Up @@ -402,3 +408,4 @@ FodyWeavers.xsd

# JetBrains Rider
*.sln.iml
## ----------------------------------------------------------------------------
16 changes: 10 additions & 6 deletions docs/HowtoGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,16 @@ Building and running `VisFroG` requires following software being installed befor
<!-- ###################################################################### -->
### Building and Installation

- Open the `VisFroG.sln` file with Visual Studio 2022
- Open the file `...\SciChartInterface\SciChartRuntimeLicenseKey.cs` and replace the comment ***"INSERT YOUR SCICHART LICENCE KEY HERE"*** with your SciChart runtime license key (this file is listed in *.gitignore* to prevent commiting your license key)
- From the menu `Build` choose `Build Solution` **Note**: The *Startup Project* should be `Interface/GrasshopperComponent`
- Move all files from the build output folder `\bin` into a new Grasshopper plugin folder, e.g.: `C:\Users\...\AppData\Roaming\Grasshopper\Libraries\VisFroG`
- Open `Rhino` and start `Grasshopper`
- In the `Visual Analysis` tab drag and drop the `VisFroG` component onto the grasshopper canvas
- Open the `VisFroG.sln` file with Visual Studio 2022.
- Open the file `...\SciChartInterface\SciChartRuntimeLicenseKey.cs` and replace the comment ***"INSERT YOUR SCICHART LICENCE KEY HERE"*** with your SciChart runtime license key.
Make git skip your local changes in `/SciChartInterface/SciChartRuntimeLicenseKey.cs``:
'''console
$ git update-index --skip-worktree SciChartInterface/SciChartRuntimeLicenseKey.cs
'''
- From the menu `Build` choose `Build Solution`. **Note**: Mkae sure that `Interface/GrasshopperComponent` is the *Startup Project*.
- Move all files from the build output folder `\bin` into a new Grasshopper plugin folder, e.g.: `C:\Users\...\AppData\Roaming\Grasshopper\Libraries\VisFroG`.
- Open `Rhino` and start `Grasshopper`.
- In the `Visual Analysis` tab drag and drop the `VisFroG` component onto the grasshopper canvas.


<!-- ###################################################################### -->
Expand Down

0 comments on commit 48612ac

Please sign in to comment.