Skip to content

Commit eba1423

Browse files
committed
docs(readme): restore local installation and wiki copy as source of truth
Realign README with the pre-rebase local version (numbered steps, init path placeholder, offline zip layout, and menu descriptions).
1 parent e78e262 commit eba1423

File tree

1 file changed

+16
-19
lines changed

1 file changed

+16
-19
lines changed

README.md

Lines changed: 16 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -11,59 +11,56 @@ The Nuke Survival Toolkit is a portable tool menu for the Foundry’s Nuke with
1111

1212
Here’s how to install and use the Nuke Survival Toolkit:
1313

14-
1. Download the .zip folder from the Nuke Survival Toolkit github website.
14+
1.) Download the .zip folder from the Nuke Survival Toolkit github website.
1515

1616
https://github.com/CreativeLyons/NukeSurvivalToolkit_publicRelease/releases/latest
1717

1818
This github will have all of the up to date changes, bug fixes, tweaks, additions, etc. So feel free to watch or star the github, and check back regularly if you’d like to stay up to date.
1919

20-
2. Copy or move the NukeSurvivalToolkit Folder either in your User/.nuke/ folder for personal use, or for use in a pipeline or to share with multiple artists, place the folder in any shared and accessible network folder.
20+
2.) Copy or move the NukeSurvivalToolkit Folder either in your User/.nuke/ folder for personal use, or for use in a pipeline or to share with multiple artists, place the folder in any shared and accessible network folder.
2121

22-
3. Open your init.py file in your /.nuke/ folder into any text editor (or create a new init.py in your User/.nuke/ directory if one doesn’t already exist)
22+
3.) Open your init.py file in your /.nuke/ folder into any text editor (or create a new init.py in your User/.nuke/ directory if one doesn’t already exist)
2323

24-
4. Copy the following code into your init.py file:
24+
4.) Copy the following code into your init.py file:
2525

2626
```
27-
nuke.pluginAddPath("CopyYour/NukeSurvivalToolkit/FolderPath/Here")
27+
nuke.pluginAddPath("Your/NukeSurvivalToolkit/FolderPath/Here")
2828
```
2929

30-
5. Copy the filepath location of where you placed your NukeSurvivalToolkit. Replace the
30+
5.) Copy the filepath location of where you placed your NukeSurvivalToolkit. Replace the
3131
Your/NukeSurvivalToolkit/FolderPath/Here text with your NukeSurvivalToolkit filepath location, making sure to keep quotation marks around the filepath.
3232

33-
6. Save your init.py file, and restart your Nuke session
33+
6.) Save your init.py file, and restart your Nuke session
34+
35+
7.) That’s it! Congrats, you will now see a little red multi-tool in your nuke toolbar.
3436

35-
7. That’s it! Congrats, you will now see a little red multi-tool in your nuke toolbar.
3637

3738
## Online Wiki
3839
For full online documentation and tool index Wiki, visit:
3940

40-
[Nuke Survival Toolkit Online Wiki](https://creativelyons.github.io/NukeSurvivalToolkit_Wiki/)
41+
[Nuke Survival Toolkit Online Wiki](https://creativelyons.github.io/NukeSurvivalToolkit_Wiki/) (live site)
4142

4243
[Wiki GitHub repository](https://github.com/CreativeLyons/NukeSurvivalToolkit_Wiki) — source, issues, and [wiki releases](https://github.com/CreativeLyons/NukeSurvivalToolkit_Wiki/releases/)
4344

4445
## Offline Documentation (optional)
4546
You can install local wiki docs for offline use.
4647

47-
1. Download the documentation ZIP release from either location:
48+
1.) Download the documentation ZIP release from either location:
4849

4950
[Nuke Survival Toolkit Releases (latest)](https://github.com/CreativeLyons/NukeSurvivalToolkit_publicRelease/releases/latest)
5051

5152
[Nuke Survival Toolkit Wiki Releases](https://github.com/CreativeLyons/NukeSurvivalToolkit_Wiki/releases/)
5253

53-
2. Unzip `NST_Documentation_Release_x.y.z.zip` and you should see a folder named `NST_Documentation`.
54-
55-
3. Move or Copy the `NST_Documentation` folder directly into your `NukeSurvivalToolkit` folder.
56-
57-
You can verify it's in the right place if this index.html file exists here:
54+
2.) Unzip `NST_Documentation_Release_x.y.z.zip` directly into the toolkit root so this file exists:
5855

5956
`NukeSurvivalToolkit/NST_Documentation/index.html`
6057

61-
4. In Nuke, open `NukeSurvivalToolkit > Documentation` and choose:
58+
3.) In Nuke, open `NukeSurvivalToolkit > Documentation` and use:
6259

6360
- `Wiki/Docs (Auto)` which falls back in this order: `Wiki (Online)` -> `Wiki (Offline)` -> `Docs (PDF)`.
64-
- `Wiki (Online)` for the online NST wiki (internet connectivity/access needed).
65-
- `Wiki (Offline)` for the local offline NST wiki. Locally sourced from the `NST_Documentation` folder
66-
- `Docs (PDF)` for local NST wiki PDF documentation.
61+
- `Wiki (Online)` for the live wiki (checked first for reachability).
62+
- `Wiki (Offline)` for local HTML docs.
63+
- `Docs (PDF)` for local PDF docs.
6764

6865
## Development
6966

0 commit comments

Comments
 (0)