diff --git a/apps/pigment-css-next-app/README.md b/apps/pigment-css-next-app/README.md index 11f66aa10d4f20..fb59fa93319754 100644 --- a/apps/pigment-css-next-app/README.md +++ b/apps/pigment-css-next-app/README.md @@ -1,6 +1,6 @@ -# Demo Next.js app for Zero Runtime +# Pigment CSS with Next.js - Demo app -This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/HEAD/packages/create-next-app). +This is a Pigment CSS and [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/HEAD/packages/create-next-app). ## Getting started @@ -16,21 +16,21 @@ Then start the Next.js development server: pnpm run --filter=@app/next-app dev ``` -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +Open [http://localhost:3000](http://localhost:3000) to see the app running live. You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. -If you see and error like package `@pigment-css/react` not found, add it as a peer-dependency in `@mui/material`'s `package.json` file and run `pnpm build` and `pnpm install` again. Make sure to not push this change to git. +If you see and error like "package `@pigment-css/react` not found", add it as a peer-dependency in `@mui/material`'s `package.json` file and run `pnpm build` and `pnpm install` again. Make sure to not push this change to git. ### Note -If you are testing changes in pigmentcss packages itself while also running this demo app, start the watch command in a separate terminal to watch and build pigmentcss package files as they change - +If you are testing changes in Pigment CSS-related packages while also running this demo app, start the watch command in a separate terminal to watch and build Pigment CSS package files as they change, like so: ```bash pnpm watch:zero ``` -You might have to restart the next.js server. +You might have to restart the Next.js server. ## Build diff --git a/apps/pigment-css-vite-app/README.md b/apps/pigment-css-vite-app/README.md index 40f1dcc6ced468..aeed955c2dbcad 100644 --- a/apps/pigment-css-vite-app/README.md +++ b/apps/pigment-css-vite-app/README.md @@ -1,22 +1,22 @@ -# Vite App +# Pigment CSS with Vite - Demo app -A sample vite application to test the working of zero runtime library. +This is a Pigment CSS with [Vite](https://vitejs.dev/) project. This project is not part of the workspace yet. ## How to run -You can either run `pnpm build` command to build all the packages, or you need to build, the the minimum - +You can either run `pnpm build` command to build all the packages or build just the most important ones: 1. `@pigment-css/react` 2. `@pigment-css/vite-plugin` -Make sure you have also run `pnpm release:build` at least once because we also use `@mui/material` and `@mui/system` packages. On subsequent runs, you can only build the above packages using - +Make sure you have run `pnpm release:build` at least once because the project is also using `@mui/material` and `@mui/system` packages. On subsequent runs, you can only build the above packages using: ```bash pnpm build ``` -After building, you can run the project by changing into the directory and then +After building, you can run the project by changing into the directory and then: 1. Install dependencies using `pnpm install` 2. Start the dev server using `pnpm dev` @@ -24,4 +24,4 @@ After building, you can run the project by changing into the directory and then Optionally, before running the dev server, you can run `pnpm vite optimize --force` if it logged some error during `pnpm vite`. -If you see and error like package `@pigment-css/react` not found, add it as a peer-dependency in `@mui/material`'s `package.json` file and run `pnpm build` and `pnpm install` again. Make sure to not push this change to git. +If you see and error like "package `@pigment-css/react` not found", add it as a peer-dependency in `@mui/material`'s `package.json` file and run `pnpm build` and `pnpm install` again. Make sure to not push this change to git.