Skip to content

Commit b60217e

Browse files
farfromrefugactions-user
authored andcommitted
chore: update readme
1 parent fca93c2 commit b60217e

File tree

2 files changed

+78
-90
lines changed

2 files changed

+78
-90
lines changed

README.md

Lines changed: 61 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +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-
### Update readme
62-
```bash
63-
npm run readme
64-
```
65-
66-
### Update doc
67-
```bash
68-
npm run doc
69-
```
70-
71-
### Publish
72-
73-
The publishing is completely handled by `lerna` (you can add `-- --bump major` to force a major release)
74-
Simply run
75-
```shell
76-
npm run publish
77-
```
78-
<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" ⚠️-->
792
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
803
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
814
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
@@ -125,9 +48,14 @@ npm run publish
12548
* [Credits](#credits)
12649
* [Examples:](#examples)
12750
* [Demos and Development](#demos-and-development)
128-
* [Setup](#setup)
51+
* [Repo Setup](#repo-setup)
12952
* [Build](#build)
13053
* [Demos](#demos)
54+
* [Contributing](#contributing)
55+
* [Update repo ](#update-repo-)
56+
* [Update readme ](#update-readme-)
57+
* [Update doc ](#update-doc-)
58+
* [Publish](#publish)
13159
* [Questions](#questions)
13260

13361

@@ -234,18 +162,18 @@ The source is based on the source code by [Krzysztof Magiera](https://github.com
234162
## Demos and Development
235163

236164

237-
### Setup
238-
239-
To run the demos, you must clone this repo **recursively**.
165+
### Repo Setup
240166

167+
The repo uses submodules. If you did not clone with ` --recursive` then you need to call
241168
```
242-
git clone https://github.com/@nativescript-community/gesturehandler.git --recursive
169+
git submodule update --init
243170
```
244171

245-
**Install Dependencies:**
246-
```bash
247-
npm i # or 'yarn install' or 'pnpm install'
248-
```
172+
The package manager used to install and link dependencies must be `pnpm` or `yarn`. `npm` wont work.
173+
174+
To develop and test:
175+
if you use `yarn` then run `yarn`
176+
if you use `pnpm` then run `pnpm i`
249177

250178
**Interactive Menu:**
251179

@@ -254,9 +182,7 @@ To start the interactive menu, run `npm start` (or `yarn start` or `pnpm start`)
254182
### Build
255183

256184
```bash
257-
npm run build
258-
259-
npm run build.angular # or for Angular
185+
npm run build.all
260186
```
261187

262188
### Demos
@@ -267,6 +193,51 @@ npm run demo.[ng|react|svelte|vue].[ios|android]
267193
npm run demo.svelte.ios # Example
268194
```
269195

196+
197+
[](#contributing)
198+
199+
200+
[](#contributing)
201+
202+
## Contributing
203+
204+
### Update repo
205+
206+
You can update the repo files quite easily
207+
208+
First update the submodules
209+
210+
```bash
211+
npm run update
212+
```
213+
214+
Then commit the changes
215+
Then update common files
216+
217+
```bash
218+
npm run sync
219+
```
220+
Then you can run `yarn|pnpm`, commit changed files if any
221+
222+
### Update readme
223+
```bash
224+
npm run readme
225+
```
226+
227+
### Update doc
228+
```bash
229+
npm run doc
230+
```
231+
232+
### Publish
233+
234+
The publishing is completely handled by `lerna` (you can add `-- --bump major` to force a major release)
235+
Simply run
236+
```shell
237+
npm run publish
238+
```
239+
240+
270241
[](#questions)
271242

272243

packages/gesturehandler/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@
5050
* [Demos](#demos)
5151
* [Contributing](#contributing)
5252
* [Update repo ](#update-repo-)
53+
* [Update readme ](#update-readme-)
54+
* [Update doc ](#update-doc-)
5355
* [Publish](#publish)
5456
* [Questions](#questions)
5557

@@ -141,6 +143,11 @@ The source is based on the source code by [Krzysztof Magiera](https://github.com
141143

142144
### Repo Setup
143145

146+
The repo uses submodules. If you did not clone with ` --recursive` then you need to call
147+
```
148+
git submodule update --init
149+
```
150+
144151
The package manager used to install and link dependencies must be `pnpm` or `yarn`. `npm` wont work.
145152

146153
To develop and test:
@@ -188,6 +195,16 @@ npm run sync
188195
```
189196
Then you can run `yarn|pnpm`, commit changed files if any
190197

198+
### Update readme
199+
```bash
200+
npm run readme
201+
```
202+
203+
### Update doc
204+
```bash
205+
npm run doc
206+
```
207+
191208
### Publish
192209

193210
The publishing is completely handled by `lerna` (you can add `-- --bump major` to force a major release)

0 commit comments

Comments
 (0)