agerix/iconify
2
0
Fork 0
mirror of https://github.com/iconify/iconify.git synced 2025-01-05 15:02:09 +00:00
Code Issues Releases Activity

Add notes for Windows development

Browse Source
This commit is contained in:
Vjacheslav Trushkin 2022-01-28 13:44:26 +02:00
parent db27b4eeae
commit d761827dff
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -85,6 +85,15 @@ If you want to remove `node_modules` for all packages, run `npm run clean`.
If you want to re-install dependencies, run `npm run reinstall`.
### Monorepo on Windows
This monorepo uses symbolic links to create links between packages. This allows development of multiple packages at the same time.
When using Windows, symbolic links require setting up extra permissions. If you are using Windows and cannot set permissions for symbolic links, there are several options:
- Use Windows Subsystem for Linux (WSL).
- Treat each package as a separate package, without links to other packages. All packages do have correct dependencies, so you will be able to use most packages (except for `browser-tests` that requires links to access directory `lib` from `iconify` package), but you will not be able to work on multiple packages at the same time.
## Documentation
Documentation for all packages is available on [Iconify documentation website](https://docs.iconify.design/icon-components/):