change(ui): add small note to readme
This commit is contained in:
parent
535eb0232e
commit
bb8c5eb182
2 changed files with 14 additions and 6 deletions
|
|
@ -1,7 +1,7 @@
|
|||
# openreplay-ui
|
||||
OpenReplay prototype UI
|
||||
|
||||
On new icon addition:
|
||||
On new icon addition:
|
||||
`yarn gen:icons`
|
||||
|
||||
## Documentation
|
||||
|
|
@ -14,3 +14,7 @@ On new icon addition:
|
|||
Labels in comments:
|
||||
TEMP = temporary code
|
||||
TODO = things to implement
|
||||
|
||||
## Contributing notes
|
||||
|
||||
Please use `dev` branch as base and target branch.
|
||||
|
|
|
|||
|
|
@ -7,16 +7,16 @@ In order to build locally any of the javascript packages located under this dire
|
|||
cd tracker # or any tracker-* plugin
|
||||
|
||||
```
|
||||
Then run
|
||||
Then run
|
||||
```sh
|
||||
yarn
|
||||
yarn build
|
||||
yarn
|
||||
yarn build
|
||||
```
|
||||
OR
|
||||
|
||||
```sh
|
||||
npm i
|
||||
npm run build
|
||||
npm i
|
||||
npm run build
|
||||
```
|
||||
|
||||
You can then use it as a local javascript package by executing the folowing line under your local project location:
|
||||
|
|
@ -29,3 +29,7 @@ OR
|
|||
npm install --save ../path/to/openreplay/monorepo/tracker/tracker
|
||||
```
|
||||
|
||||
|
||||
## Contributing notes
|
||||
|
||||
Please use `dev` branch as base and target branch.
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue