Skip to content

Commit 991b951

Browse files
committed
update readme
1 parent 233f372 commit 991b951

File tree

1 file changed

+52
-42
lines changed

1 file changed

+52
-42
lines changed

README.md

Lines changed: 52 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,41 @@
1-
# Nuke Tools ST README
1+
# 1. Nuke Tools ST README
22

33
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/522af2c16ed84926b77f2e095cfa8b87)](https://www.codacy.com/gh/sisoe24/Nuke-Tools-ST/dashboard?utm_source=github.com&utm_medium=referral&utm_content=sisoe24/Nuke-Tools-ST&utm_campaign=Badge_Grade)
44
[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/522af2c16ed84926b77f2e095cfa8b87)](https://www.codacy.com/gh/sisoe24/Nuke-Tools-ST/dashboard?utm_source=github.com&utm_medium=referral&utm_content=sisoe24/Nuke-Tools-ST&utm_campaign=Badge_Coverage)
55
[![DeepSource](https://deepsource.io/gh/sisoe24/Nuke-Tools-ST.svg/?label=active+issues&show_trend=true&token=Yrd2y9gG7y8h53JsDwyjQdFZ)](https://deepsource.io/gh/sisoe24/Nuke-Tools-ST/?ref=repository-badge)
66

7+
[![PackageControl](https://img.shields.io/badge/Package%20Control-Download-informational)](https://packagecontrol.io/packages/NukeToolsST)
8+
9+
710
> This is a companion extension for: [NukeServerSocket](#nukeserversocket) and is based on [NukeTools](https://marketplace.visualstudio.com/items?itemName=virgilsisoe.nuke-tools).
811
912
A Sublime Text package that allows to send python or blinkscript code to be executed inside Nuke.
1013

11-
- [Nuke Tools ST README](#nuke-tools-st-readme)
12-
- [Features](#features)
13-
- [Installation](#installation)
14-
- [BlinkScript](#blinkscript)
15-
- [Connection](#connection)
16-
- [Note](#note)
17-
- [Package Settings](#package-settings)
18-
- [`nss_port`:`integer`](#nss_portinteger)
19-
- [`nss_hostname`:`string`](#nss_hostnamestring)
20-
- [`nss_disable_context_menu`:`bool`](#nss_disable_context_menubool)
21-
- [Example](#example)
22-
- [Commands](#commands)
23-
- [Key Bindings](#key-bindings)
24-
- [NukeServerSocket](#nukeserversocket)
25-
- [Changelog](#changelog)
26-
- [Overview](#overview)
27-
28-
## Features
14+
- [1. Nuke Tools ST README](#1-nuke-tools-st-readme)
15+
- [1.1. NukeServerSocket](#11-nukeserversocket)
16+
- [1.2. Features](#12-features)
17+
- [1.3. Installation](#13-installation)
18+
- [1.4. Usage](#14-usage)
19+
- [1.4. BlinkScript](#14-blinkscript)
20+
- [1.5. Connection](#15-connection)
21+
- [1.6. Package Settings](#16-package-settings)
22+
- [1.6.1. `nss_port`:`integer`](#161-nss_portinteger)
23+
- [1.6.2. `nss_hostname`:`string`](#162-nss_hostnamestring)
24+
- [1.6.3. `nss_disable_context_menu`:`bool`](#163-nss_disable_context_menubool)
25+
- [1.6.4. Example](#164-example)
26+
- [1.7. Commands](#17-commands)
27+
- [1.8. Key Bindings](#18-key-bindings)
28+
- [1.9. Changelog](#19-changelog)
29+
- [1.10. Overview](#110-overview)
30+
31+
## 1.1. NukeServerSocket
32+
33+
Download the companion plugin:
34+
35+
- [Github](https://github.com/sisoe24/NukeServerSocket/releases)
36+
- [Nukepedia](http://www.nukepedia.com/python/misc/nukeserversocket)
37+
38+
## 1.2. Features
2939

3040
- Execute code inside Nuke from a machine in your local network.
3141
- Get output of Nuke code execution inside Sublime console.
@@ -34,23 +44,28 @@ A Sublime Text package that allows to send python or blinkscript code to be exec
3444
- Multiple connections can be made to the same Nuke instance.
3545
- BlinkScript support.
3646

37-
## Installation
47+
## 1.3. Installation
3848

3949
The preferred method of installation is via the [Package Control](https://packagecontrol.io).
4050

41-
- [Link](https://packagecontrol.io/packages/NukeToolsST)
51+
- [Package Link](https://packagecontrol.io/packages/NukeToolsST)
52+
- Inside Sublime, invoke the **Command Palette** -> **Install Package** -> **NukeToolsST**.
53+
54+
## 1.4. Usage
55+
56+
[Demo](#110-overview)
4257

43-
## BlinkScript
58+
Once NukeServerSocket is up and running, you can execute your python/blink file with the new [command](#17-commands).
4459

45-
> [NukeServerSocket](#nukeserversocket) >= 0.1.0 is needed in order for this to work.
60+
## 1.4. BlinkScript
4661

47-
You can execute code from the text editor directly inside a Nuke BlinkScript node.
62+
> NukeServerSocket >= 0.1.0 is needed in order for this to work.
4863
49-
The extension will take the name of the current active file and create a blinkscript node inside Nuke with the name as the current filename. If the node already exists then will only modified its source code. Once done will recompile the source kernel.
64+
The extension will take the name of the current active file and create a blinkscript node inside Nuke with the name as the current filename. If the node already exists, then will only modified its source code. Once done will recompile the source kernel.
5065

5166
The accepted file extension are `.cpp` or `.blink`.
5267

53-
## Connection
68+
## 1.5. Connection
5469

5570
No settings are necessary if connection is expected to be on the same computer.
5671
NukeToolsST will automatically connect to the `localhost` and will use the port
@@ -60,26 +75,24 @@ However if connection is between different computers, port and hostname must be
6075

6176
> Keep in mind that, once the addresses are specified manually, will always take over the defaults one. Its best to delete them if you only connect between the same computer.
6277
63-
### Note
64-
65-
Attempting to connect to a manually specified host that is down (not reachable)
78+
**Note**: Attempting to connect to a manually specified host that is down (not reachable)
6679
will result in a temporary freeze of the Sublime UI for 10 seconds.
6780

68-
## Package Settings
81+
## 1.6. Package Settings
6982

70-
### `nss_port`:`integer`
83+
### 1.6.1. `nss_port`:`integer`
7184

7285
A different port for the connection. Port should match the one from NukeServerSocket.
7386

74-
### `nss_hostname`:`string`
87+
### 1.6.2. `nss_hostname`:`string`
7588

7689
Same as `nss_port`. Host could be the localhost or the local ip.
7790

78-
### `nss_disable_context_menu`:`bool`
91+
### 1.6.3. `nss_disable_context_menu`:`bool`
7992

80-
Disable Sublime context menu entry if not needed (clean up). Defaults to `false`.
93+
Disable Sublime context menu entry if not needed. Defaults to `false`.
8194

82-
### Example
95+
### 1.6.4. Example
8396

8497
```json
8598
{
@@ -89,7 +102,7 @@ Disable Sublime context menu entry if not needed (clean up). Defaults to `false`
89102
}
90103
```
91104

92-
## Commands
105+
## 1.7. Commands
93106

94107
The following command will be available: `run_nuke_tools`.
95108

@@ -99,7 +112,7 @@ A new entry "Run Code inside Nuke" will be added to the context menu (right clic
99112
- `.cpp`
100113
- `.blink`
101114

102-
## Key Bindings
115+
## 1.8. Key Bindings
103116

104117
The package does not include any key bindings by default but you can add them by following the [Sublime Text Key Bindings guide](https://www.sublimetext.com/docs/key_bindings.html).
105118

@@ -114,11 +127,8 @@ Example
114127
]
115128
```
116129

117-
## NukeServerSocket
118-
119-
Download the companion plugin: [Git](https://github.com/sisoe24/NukeServerSocket/releases), [Nukepedia](http://www.nukepedia.com/python/misc/nukeserversocket).
120130

121-
## Changelog
131+
## 1.9. Changelog
122132

123133
[0.2.0] 11-04-2021
124134

@@ -131,6 +141,6 @@ Download the companion plugin: [Git](https://github.com/sisoe24/NukeServerSocket
131141

132142
- Initial release.
133143

134-
## Overview
144+
## 1.10. Overview
135145

136146
![example](example.gif)

0 commit comments

Comments
 (0)