From bb8c5eb1824959c059aecd2650a7a0ce0090c883 Mon Sep 17 00:00:00 2001 From: sylenien Date: Thu, 20 Oct 2022 11:32:35 +0200 Subject: [PATCH] change(ui): add small note to readme --- frontend/README.md | 6 +++++- tracker/README.md | 14 +++++++++----- 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/frontend/README.md b/frontend/README.md index e2b4a3898..3eb54ede6 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -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. diff --git a/tracker/README.md b/tracker/README.md index f283ee3a8..64a06f51e 100644 --- a/tracker/README.md +++ b/tracker/README.md @@ -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.