Skip to content

Commit

Permalink
edit the example app's readme files
Browse files Browse the repository at this point in the history
  • Loading branch information
danilo-leal committed Mar 25, 2024
1 parent 9a84228 commit 995a03b
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
12 changes: 6 additions & 6 deletions apps/pigment-css-next-app/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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

Expand Down
12 changes: 6 additions & 6 deletions apps/pigment-css-vite-app/README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
# 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`
3. Build the code using `pnpm build`

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.

0 comments on commit 995a03b

Please sign in to comment.