Skip to content

Commit c4be1c5

Browse files
authored
docs: update contributing docs (nativescript-vue#751)
* docs: update CONTRIBUTING now that runner is gone * chore: remove samples command
1 parent f1110f1 commit c4be1c5

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,11 @@ $ yarn dev
3838

3939
To test the sample applications provided in the repository, you need to `yarn dev` in the root directory. This will watch for changes, and rebuild nativescript-vue, which in dev mode will be generated into the samples/app directory (this has been done to reduce the required steps of linking local packages, which had many issues with the recent releases of npm).
4040

41-
Next, open up a new terminal window and run `yarn samples`. This will bring up a list of all the available sample applications which you can choose from with your arrow keys. Pressing enter/return will select that sample, and prompt you to choose the platform you'd like to run the sample on. After selecting the platform the application should start on your emulator, and the output will be in your terminal.
41+
Next, open up a new terminal window and change directory to samples `cd samples`.
4242

43-
If you want to test the sample apps with HMR activated, please run `yarn samples -- --hmr` instead. Actually, we can pass any arguments to the `tns debug platform` command placing them after the `--` separator.
43+
If you want to test the sample apps, please run `ns run <platform> --no-hmr` (disabling hmr isn't necessary, but preferred most of the time).
44+
45+
To test a different/new sample edit `app/entry.js` and update the `require('./<sample>')` statement to require any of the samples in the app folder.
4446

4547
# Project Structure
4648

package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@
1414
"scripts": {
1515
"test": "jest",
1616
"tdd": "jest --watch",
17-
"samples": "node build/sample-runner.js",
1817
"dev": "npm run dev:core -- -w & npm run dev:compiler -- -w",
1918
"dev:core": "rollup -c build/config.js --o dist/index.js --environment TARGET:nativescript-vue",
2019
"dev:compiler": "rollup -c build/config.js --environment TARGET:nativescript-vue-template-compiler",

0 commit comments

Comments
 (0)