Skip to content

Commit e9b9e0b

Browse files
farfromrefugactions-user
authored andcommitted
chore: update readme
1 parent 1c2ebff commit e9b9e0b

File tree

1 file changed

+1
-78
lines changed

1 file changed

+1
-78
lines changed

README.md

Lines changed: 1 addition & 78 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 monorepo contains multiple packages:<br><br><details>
1+
<!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️-->This monorepo contains multiple packages:<br><br><details>
792
<summary><b>activityindicator</b></summary>
803

814
[](#nativescript-material-circular-progress-indicator)

0 commit comments

Comments
 (0)