Skip to content

Commit 89c2416

Browse files
farfromrefugfarfromrefug
committed
chore: readmme
1 parent 1459375 commit 89c2416

File tree

2 files changed

+152
-68
lines changed

2 files changed

+152
-68
lines changed

‎README.md

Lines changed: 125 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,4 @@
1-
<!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️-->
2-
[](#demos-and-development)
3-
4-
## Demos and Development
5-
6-
7-
### Repo Setup
8-
9-
The repo uses submodules. If you did not clone with ` --recursive` then you need to call
10-
```
11-
git submodule update --init
12-
```
13-
14-
The package manager used to install and link dependencies must be `pnpm` or `yarn`. `npm` wont work.
15-
16-
To develop and test:
17-
if you use `yarn` then run `yarn`
18-
if you use `pnpm` then run `pnpm i`
19-
20-
**Interactive Menu:**
21-
22-
To start the interactive menu, run `npm start` (or `yarn start` or `pnpm start`). This will list all of the commonly used scripts.
23-
24-
### Build
25-
26-
```bash
27-
npm run build.all
28-
```
29-
30-
### Demos
31-
32-
```bash
33-
npm run demo.[ng|react|svelte|vue].[ios|android]
34-
35-
npm run demo.svelte.ios # Example
36-
```
37-
38-
39-
[](#contributing)
40-
41-
## Contributing
42-
43-
### Update repo
44-
45-
You can update the repo files quite easily
46-
47-
First update the submodules
48-
49-
```bash
50-
npm run update
51-
```
52-
53-
Then commit the changes
54-
Then update common files
55-
56-
```bash
57-
npm run sync
58-
```
59-
Then you can run `yarn|pnpm`, commit changed files if any
60-
61-
### Publish
62-
63-
The publishing is completely handled by `lerna` (you can add `-- --bump major` to force a major release)
64-
Simply run
65-
```shell
66-
npm run publish
67-
```
68-
<br><br><!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️-->
1+
<!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️--><!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️-->
692
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
703
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
714
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
@@ -127,7 +60,10 @@ npm run publish
12760
* [Demos](#demos-1)
12861
* [Contributing](#contributing)
12962
* [Update repo ](#update-repo-)
63+
* [Update readme ](#update-readme-)
64+
* [Update doc ](#update-doc-)
13065
* [Publish](#publish)
66+
* [modifying submodules](#modifying-submodules)
13167
* [Questions](#questions)
13268

13369

@@ -376,6 +312,7 @@ To start the interactive menu, run `npm start` (or `yarn start` or `pnpm start`)
376312
```bash
377313
npm run build.all
378314
```
315+
WARNING: it seems `yarn build.all` wont always work (not finding binaries in `node_modules/.bin`) which is why the doc explicitly uses `npm run`
379316

380317
### Demos
381318

@@ -385,6 +322,10 @@ npm run demo.[ng|react|svelte|vue].[ios|android]
385322
npm run demo.svelte.ios # Example
386323
```
387324

325+
Demo setup is a bit special in the sense that if you want to modify/add demos you dont work directly in `demo-[ng|react|svelte|vue]`
326+
Instead you work in `demo-snippets/[ng|react|svelte|vue]`
327+
You can start from the `install.ts` of each flavor to see how to register new demos
328+
388329

389330
[](#contributing)
390331

@@ -411,6 +352,16 @@ npm run sync
411352
```
412353
Then you can run `yarn|pnpm`, commit changed files if any
413354

355+
### Update readme
356+
```bash
357+
npm run readme
358+
```
359+
360+
### Update doc
361+
```bash
362+
npm run doc
363+
```
364+
414365
### Publish
415366

416367
The publishing is completely handled by `lerna` (you can add `-- --bump major` to force a major release)
@@ -419,9 +370,115 @@ Simply run
419370
npm run publish
420371
```
421372

373+
### modifying submodules
374+
375+
The repo uses https:// for submodules which means you won't be able to push directly into the submodules.
376+
One easy solution is t modify `~/.gitconfig` and add
377+
```
378+
[url "ssh://[email protected]/"]
379+
pushInsteadOf = https://github.com/
380+
```
381+
382+
383+
[](#questions)
384+
422385

423386
[](#questions)
424387

388+
## Questions
389+
390+
If you have any questions/issues/comments please feel free to create an issue or start a conversation in the [NativeScript Community Discord](https://nativescript.org/discord).
391+
392+
[](#demos-and-development)
393+
394+
## Demos and Development
395+
396+
397+
### Repo Setup
398+
399+
The repo uses submodules. If you did not clone with ` --recursive` then you need to call
400+
```
401+
git submodule update --init
402+
```
403+
404+
The package manager used to install and link dependencies must be `pnpm` or `yarn`. `npm` wont work.
405+
406+
To develop and test:
407+
if you use `yarn` then run `yarn`
408+
if you use `pnpm` then run `pnpm i`
409+
410+
**Interactive Menu:**
411+
412+
To start the interactive menu, run `npm start` (or `yarn start` or `pnpm start`). This will list all of the commonly used scripts.
413+
414+
### Build
415+
416+
```bash
417+
npm run build.all
418+
```
419+
WARNING: it seems `yarn build.all` wont always work (not finding binaries in `node_modules/.bin`) which is why the doc explicitly uses `npm run`
420+
421+
### Demos
422+
423+
```bash
424+
npm run demo.[ng|react|svelte|vue].[ios|android]
425+
426+
npm run demo.svelte.ios # Example
427+
```
428+
429+
Demo setup is a bit special in the sense that if you want to modify/add demos you dont work directly in `demo-[ng|react|svelte|vue]`
430+
Instead you work in `demo-snippets/[ng|react|svelte|vue]`
431+
You can start from the `install.ts` of each flavor to see how to register new demos
432+
433+
434+
[](#contributing)
435+
436+
## Contributing
437+
438+
### Update repo
439+
440+
You can update the repo files quite easily
441+
442+
First update the submodules
443+
444+
```bash
445+
npm run update
446+
```
447+
448+
Then commit the changes
449+
Then update common files
450+
451+
```bash
452+
npm run sync
453+
```
454+
Then you can run `yarn|pnpm`, commit changed files if any
455+
456+
### Update readme
457+
```bash
458+
npm run readme
459+
```
460+
461+
### Update doc
462+
```bash
463+
npm run doc
464+
```
465+
466+
### Publish
467+
468+
The publishing is completely handled by `lerna` (you can add `-- --bump major` to force a major release)
469+
Simply run
470+
```shell
471+
npm run publish
472+
```
473+
474+
### modifying submodules
475+
476+
The repo uses https:// for submodules which means you won't be able to push directly into the submodules.
477+
One easy solution is t modify `~/.gitconfig` and add
478+
```
479+
[url "ssh://[email protected]/"]
480+
pushInsteadOf = https://github.com/
481+
```
425482

426483
[](#questions)
427484

‎packages/ui-persistent-bottomsheet/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,10 @@
5757
* [Demos](#demos-1)
5858
* [Contributing](#contributing)
5959
* [Update repo ](#update-repo-)
60+
* [Update readme ](#update-readme-)
61+
* [Update doc ](#update-doc-)
6062
* [Publish](#publish)
63+
* [modifying submodules](#modifying-submodules)
6164
* [Questions](#questions)
6265

6366

@@ -279,6 +282,7 @@ To start the interactive menu, run `npm start` (or `yarn start` or `pnpm start`)
279282
```bash
280283
npm run build.all
281284
```
285+
WARNING: it seems `yarn build.all` wont always work (not finding binaries in `node_modules/.bin`) which is why the doc explicitly uses `npm run`
282286

283287
### Demos
284288

@@ -288,6 +292,10 @@ npm run demo.[ng|react|svelte|vue].[ios|android]
288292
npm run demo.svelte.ios # Example
289293
```
290294

295+
Demo setup is a bit special in the sense that if you want to modify/add demos you dont work directly in `demo-[ng|react|svelte|vue]`
296+
Instead you work in `demo-snippets/[ng|react|svelte|vue]`
297+
You can start from the `install.ts` of each flavor to see how to register new demos
298+
291299

292300
[](#contributing)
293301

@@ -311,6 +319,16 @@ npm run sync
311319
```
312320
Then you can run `yarn|pnpm`, commit changed files if any
313321

322+
### Update readme
323+
```bash
324+
npm run readme
325+
```
326+
327+
### Update doc
328+
```bash
329+
npm run doc
330+
```
331+
314332
### Publish
315333

316334
The publishing is completely handled by `lerna` (you can add `-- --bump major` to force a major release)
@@ -319,6 +337,15 @@ Simply run
319337
npm run publish
320338
```
321339

340+
### modifying submodules
341+
342+
The repo uses https:// for submodules which means you won't be able to push directly into the submodules.
343+
One easy solution is t modify `~/.gitconfig` and add
344+
```
345+
[url "ssh://[email protected]/"]
346+
pushInsteadOf = https://github.com/
347+
```
348+
322349

323350
[](#questions)
324351

0 commit comments

Comments
 (0)