Skip to content

Commit 73b3d7b

Browse files
committed
Merge branch 'master' of ssh://[email protected]/shotgunsoftware/tk-multi-starterapp.git
2 parents b629bff + 174d510 commit 73b3d7b

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Welcome to the Shotgun Pipeline Toolkit Starter App
1+
# Welcome to the Shotgun Pipeline Toolkit Starter App!
22

33
This app serves as a quick way to get started when doing Toolkit App development.
44
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:
88
First of all, fork this repo. You can fork it to your own github accout or fork it to
99
an internal git server, that's totally up to you! At this time, make sure you also
1010
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`.
1213

1314
## Step 2. Install your forked App in Toolkit
1415

16+
### Create a Dev Area
1517
Now, first things first - before starting development, let's install the App. First, create a
1618
development sandbox for your project by going to the pipeline configurations page in Shotgun
1719
and click select "Clone" on the menu when right clicking on the primary pipeline configuration.
1820
This will give you a private place to do development and you wont be disturbing the production.
1921

22+
### Install the new repository
2023
With your development sandbox there will be a specific tank command that you can use to address
2124
this particular configuration. Open a shell and navigate to your sandbox. Now run the install app
2225
command. When you install an app, you need to choose an environment and an engine. The engine is

0 commit comments

Comments
 (0)