Skip to content

Commit c2ab0dc

Browse files
committed
docs(readme): added cloning instructions to readme
1 parent 3115fc6 commit c2ab0dc

1 file changed

Lines changed: 5 additions & 2 deletions

File tree

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,15 @@ This repo contains various generators for external project
1616
### Dependencies
1717
* node
1818
* yarn
19-
### Building
19+
### Setup
20+
* Clone the project **recursively** and **with ssh**
21+
* `git clone git@github.com:JumpCutter/JC-ProjectExportAPI --recursive`
2022
* Install yarn if you don't have it
2123
* `npm i yarn -g`
2224
* Build
2325
* `yarn build`
24-
* Run tests
26+
### Tests
27+
* Run tests (this does not require `yarn build`
2528
* `yarn test`
2629

2730
## Testing

0 commit comments

Comments
 (0)