Manav Rathi 1 год назад
Родитель
Сommit
703031f73c
2 измененных файлов с 28 добавлено и 0 удалено
  1. 19 0
      docs/Dev.md
  2. 9 0
      docs/README.md

+ 19 - 0
docs/Dev.md

@@ -0,0 +1,19 @@
+## Monorepo
+
+The monorepo uses Yarn (classic) workspaces.
+
+To run a command for a workspace `<ws>`, invoke `yarn workspace <ws> <cmd>` from
+the root folder instead the the `yarn <cmd>` you’d have done otherwise.
+
+To add a local package as a dependency, use `<package-name>@*`. The "*" here
+denotes any version.
+
+```sh
+yarn workspace photos add '@/utils@*'
+```
+
+To see what packages depend on each other locally, use
+
+```sh
+yarn workspaces info
+```

+ 9 - 0
docs/README.md

@@ -0,0 +1,9 @@
+## Notes for maintainers
+
+If you just want to run ente locally or develop on it, you can do
+
+    yarn
+    yarn photos:dev
+
+The notes in this directory are for maintainers to note down more advanced or
+infrequently needed details.