ui-core: add build instructions to readme file

OpenRailAssociation · Jul 6, 2024 · 5464062 · 5464062
1 parent 8034a62
commit 5464062
Show file tree

Hide file tree

Showing 3 changed files with 12,006 additions and 13,820 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,20 @@
 
 Icons, fonts, colors, components and all user interface items for OSRD project.
 
+# Build Instructions
+
+1. Go to the project's `root` directory in your terminal
+2. Run `sudo chown -R $(whoami) ~/.npm`
+3. Enter your computer's password
+4. Run `rm -rf node_modules package-lock.json`
+5. Run `npm cache clean --force`
+6. Run `npm install @nx/nx-darwin-x64`
+7. Run `npm install @rollup/rollup-darwin-x64`
+8. Run `npm run clean`
+9. Run `npm run build`
+10. Run `npm run test`
+11. Run `npm run storybook`
+
 ## TODO
 
 We should write a README to explain the goal of the `osrd-ui` repository and the design system as