Skip to content

Commit 4d6b7b4

Browse files
committed
Instructions for creating a symlink added
1 parent fda7c25 commit 4d6b7b4

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs/SCIRun5ModuleGeneration.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1468,3 +1468,23 @@ tags: module
14681468

14691469
#### 8.3 Creating the Symbolic Link
14701470
Create a symbolic link in `docs/modules` with the same name that points to this new file you created.
1471+
1472+
##### OS X/Linux
1473+
Execute `ln` command
1474+
```
1475+
ln -s path/to/original path/to/link
1476+
```
1477+
For example, if you are in the SCIRun directory, this is what the command might look like:
1478+
```
1479+
ln -s docs/_includes/modules/ModuleName.md /docs/modules/ModuleName.md
1480+
```
1481+
1482+
##### Windows
1483+
Run Command Prompt as administrator (Right-click on application and click *Run as Administrator*). Execute `mklink` command
1484+
```
1485+
mklink /path/to/original /path/to/link
1486+
```
1487+
For example, if you are in the SCIRun directory, this is what the command might look like:
1488+
```
1489+
mklink docs/_includes/modules/ModuleName.md /docs/modules/ModuleName.md
1490+
```

0 commit comments

Comments
 (0)