jan/openreplay
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

change(ui): add small note to readme

Browse source
This commit is contained in:
sylenien 2022-10-20 11:32:35 +02:00
parent 535eb0232e
commit bb8c5eb182
2 changed files with 14 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
frontend/README.md
View file

@ -1,7 +1,7 @@
# openreplay-ui # openreplay-ui
OpenReplay prototype UI OpenReplay prototype UI
On new icon addition: On new icon addition:
`yarn gen:icons` `yarn gen:icons`
## Documentation ## Documentation
@ -14,3 +14,7 @@ On new icon addition:
Labels in comments: Labels in comments:
TEMP = temporary code TEMP = temporary code
TODO = things to implement TODO = things to implement
## Contributing notes
Please use `dev` branch as base and target branch.

14
tracker/README.md
View file

@ -7,16 +7,16 @@ In order to build locally any of the javascript packages located under this dire
cd tracker # or any tracker-* plugin cd tracker # or any tracker-* plugin
``` ```
Then run Then run
```sh ```sh
yarn yarn
yarn build yarn build
``` ```
OR OR
```sh ```sh
npm i npm i
npm run build npm run build
``` ```
You can then use it as a local javascript package by executing the folowing line under your local project location: 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 npm install --save ../path/to/openreplay/monorepo/tracker/tracker
``` ```
## Contributing notes
Please use `dev` branch as base and target branch.