Skip to content

Commit 2429117

Browse files
committed
docs: enhance DEVELOPING guide
1 parent 296ab1c commit 2429117

File tree

1 file changed

+32
-7
lines changed

1 file changed

+32
-7
lines changed

DEVELOPING.adoc

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,38 @@ yarn install
2626

2727
Package sources are located in `packages/render-html`.
2828

29-
== Build libraries
29+
30+
== Scripts
31+
32+
The project is using
33+
Yarn Berry's workspaces. There is an alias to work from
34+
`react-native-render-html` workspace:
35+
36+
```
37+
yarn render-html
38+
```
39+
40+
You can then run the following commands:
41+
42+
[cols="1,1"]
43+
|===
44+
| Most significant scripts
45+
| Description
46+
47+
| `yarn render-html test:jest --watch`
48+
| Launch jest test in watch mode
49+
50+
| `yarn render-html test:ts`
51+
| Run Typescript typechecking
52+
53+
| `yarn render-html test:lint`
54+
| Run linter
55+
56+
| `yarn render-html build`
57+
| Transpile TS → ES
58+
|===
59+
60+
== Demo app
3061

3162
```
3263
yarn build:tools
@@ -38,12 +69,6 @@ From now-on, you should be able to try-out the demo app with
3869
yarn demo start
3970
```
4071

41-
== Run tests
42-
43-
```
44-
yarn render-html test:jest --watch
45-
```
46-
4772
== Documentation
4873

4974
All the doc pages are React components available in

0 commit comments

Comments
 (0)