1
- # Welcome to the Shotgun Pipeline Toolkit Starter App
1
+ # Welcome to the Shotgun Pipeline Toolkit Starter App!
2
2
3
3
This app serves as a quick way to get started when doing Toolkit App development.
4
4
If you want to get up and running quickly, follow these simple steps:
@@ -8,15 +8,18 @@ If you want to get up and running quickly, follow these simple steps:
8
8
First of all, fork this repo. You can fork it to your own github accout or fork it to
9
9
an internal git server, that's totally up to you! At this time, make sure you also
10
10
rename it to something sensible. We recommend the naming convention ` tk-ENGINE-APPNAME ` ,
11
- where ENGINE is set to ` multi ` if the app can run in more than one engine.
11
+ where ENGINE is set to ` multi ` if the app can run in more than one engine. For example,
12
+ if you are working on a rigging tool in maya, you may want to name it ` tk-maya-characterposer ` .
12
13
13
14
## Step 2. Install your forked App in Toolkit
14
15
16
+ ### Create a Dev Area
15
17
Now, first things first - before starting development, let's install the App. First, create a
16
18
development sandbox for your project by going to the pipeline configurations page in Shotgun
17
19
and click select "Clone" on the menu when right clicking on the primary pipeline configuration.
18
20
This will give you a private place to do development and you wont be disturbing the production.
19
21
22
+ ### Install the new repository
20
23
With your development sandbox there will be a specific tank command that you can use to address
21
24
this particular configuration. Open a shell and navigate to your sandbox. Now run the install app
22
25
command. When you install an app, you need to choose an environment and an engine. The engine is
0 commit comments