CaptainCodeman / svelte-headlessui

HeadlessUI components for Svelte
https://captaincodeman.github.io/svelte-headlessui/
MIT License
554 stars 25 forks source link

Add project setup instructions in the readme #39

Closed mattcroat closed 1 year ago

mattcroat commented 1 year ago

I'm not that familiar with monorepos but I managed to get the project working using intuition and some luck but it would be great to include instructions for people who want to contribute and ones that just want to explore and learn how it works — I can open a pull request if someone enlightens me on the correct setup.

CaptainCodeman commented 1 year ago

I don't think every library should have instructions on how to use the tools, but we should have some high level description about what is where and which tools are used.

In this case it's "use pnpm and run the dev script in the lib project"

mattcroat commented 1 year ago

we should have some high level description about what is where and which tools are used

That's what I meant! 😄

In this case it's "use pnpm and run the dev script in the lib project"

Do you run install for the dependencies from the root or have to do it inside lib and docs for each package? I hoped to find the answer in pnpm docs but the workspace section is short.

I had to do pnpm run build inside packages/lib to make the docs work.

CaptainCodeman commented 1 year ago

pnpm i from the root installs all dependencies. pnpm -r build from the root builds everything.

A google search will pull up plenty of resources on how mono repos work and specifically how to use pnpm.