From 5b69b4fdaf51c9ab0d2d1ccb153c2c45f48fdd0a Mon Sep 17 00:00:00 2001 From: RUN-Projects <82665975+RUN-Projects@users.noreply.github.com> Date: Tue, 16 Jan 2024 13:49:40 -0600 Subject: [PATCH] Add node linker and interactive tools to yarn instructions. --- README.md | 27 ++++++++++++++++++++------- 1 file changed, 20 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 5ebb008..a73a3ce 100644 --- a/README.md +++ b/README.md @@ -162,19 +162,32 @@ If you would like to fork the repo and create a pull request. ```sh git clone https://github.com/unfoldingWord/oce-editor-tools.git ``` -3. Install NPM packages +3. Delete .yarnrc.yml +4. Confirm which version of yarn is running on this project ```sh - yarn + yarn -v ``` -4. Run a package locally, for instance: + If 3.x then add interactive-tools. (If 4.x then skip this step as interactive tools are already included.) + ```sh + yarn plugin import interactive-tools + ``` +5. Install NPM packages + ```sh + yarn install + ``` +6. Defines linker for installing Node packages + ```sh + yarn config set nodeLinker node-modules + ``` +7. Run a package locally, for instance: ```sh yarn nx start @oce-editor-tools/mui-simple ``` -5. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) -6. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) -7. Push to the Branch (`git push origin feature/AmazingFeature`) -8. Open a Pull Request +8. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) +9. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) +10. Push to the Branch (`git push origin feature/AmazingFeature`) +11. Open a Pull Request