Showreel Studio Help
Help · Connecting your app

Give the writers your app's code

Optionally point Showreel Studio at the folder with your app's code, so scripts and decks can draw on its docs, code and pull requests.

The writers that draft your scripts and decks can read your app's code as well as, or instead of, a walk of the app. This is optional. If you don't work with the code, leave it empty and let Showreel Studio explore your app instead.

What the writers read

From the folder you give, they gather:

  • the README, and docs and plans that name the feature;
  • the source files that mention it, most mentions first;
  • the commits that mention it;
  • a pull request, if you give its number.

Every claim in what they write has to come from what they were given, so read the result before you approve it. See Who writes your scripts.

Before you start

  • The app connected: Connect your app.
  • The code on your Mac, in a folder (usually a git repository).

In the app

  1. Open Apps.
  2. In The app's code, type the folder, or click Browse… to choose it.
  3. Click Save. Clear removes it.

You can also give or change the folder where you write: in the New film and New deck dialogs, and in a film's Write the script card on the Film panel. Any of these saves it for the project.

In the terminal

Set "repo" in the project's showreel.json, or give the folder each time:

showreel storyboard compose --feature "Compose" --repo ~/code/my-app --pr 42

Leave the code out of one write, even when the project has a folder set:

showreel storyboard compose --feature "Compose" --explore --no-repo
showreel storyboard compose --feature "Compose" --explore --repo ~/code/my-app

What next