Skip to content

Commit 199984c

Browse files
committed
chore: Additional doc info about effects of local development flag.
1 parent ebec259 commit 199984c

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@ If you want to test your work within the context of a project and your change do
2121

2222
### Outline CLI and project template development
2323

24-
When adjusting the project initialization process it can be executed via direct reference instead of using the `@phase2/outline-cli` package. There is also a flag to the `init` command, `-l`, that will cause the templates used to come from the `../packages/outline-templates` and `../packages/outline-storybook` directories instead of the published `@phase2/outline-templates` and `@phase2/outline-storybook` packages.
24+
When adjusting the project initialization process it can be executed via direct reference instead of using the `@phase2/outline-cli` package. There is also a flag to the `init` command, `-l`, that will cause the templates used to come from the `../packages/outline-templates` and `../packages/outline-storybook` directories instead of the published `@phase2/outline-templates` and `@phase2/outline-storybook` packages. It will also cause the initial `yarnpkg` command in the generated project to be skipped.
2525

2626
For example, to spin up a project directory as a sibling to this repo run:
2727

2828
```bash
2929
npx ./outline/packages/outline-cli init -l
3030
```
3131

32-
> Note that this does not currently cause any initially installed packages to use linking technique above.
32+
> Note: Do not forget to execute a build before testing the project initialization process. Use of the -l flag does not currently cause any initially installed packages to use linking technique above.

0 commit comments

Comments
 (0)