diff --git a/README.md b/README.md index 5da3384..5dcaff0 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ ProzillaOS is a web-based operating system inspired by Ubuntu Linux and Windows. ## Packages -### Libraries +### Libraries (external) These libraries are different modules of ProzillaOS that can be installed separately or via the bundle package `prozilla-os`. Each library has a `src/main.ts` entry file and is published to the npm registry. @@ -41,12 +41,12 @@ These libraries are different modules of ProzillaOS that can be installed separa - [`@prozilla-os/logic-sim`][logic-sim]: Logic simulator app -### Sites +### Sites (internal) These packages contains the source code of parts of the ProzillaOS website. They are published to GitHub pages. -- [`prozilla-os-demo`](./packages/demo/): Demo site -- [`prozilla-os-docs`](./packages/docs/): Documentation site +- [`@prozilla-os/demo`](./packages/demo/): Demo site +- [`@prozilla-os/docs`](./packages/docs/): Documentation site ## Scripts @@ -59,8 +59,9 @@ ProzillaOS uses the package manager [pnpm](https://pnpm.io/) to run scripts. |
pnpm run start| Run [`pnpm run site:start`](#package-prozilla-os-demo). VSCode is configured to run this script whenever the project is opened. |
pnpm run build| Build every package in sequential order. |
pnpm run deploy| Clear the `dist` directory, build and stage each package that comprises the website, then deploy to GitHub pages. This should then trigger a GitHub Action that deploys the build to production. +|
pnpm run publish| Publish the `dist` directory to GitHub pages. -### Libraries +### External packages | Script | Description | | --- | --- | @@ -71,18 +72,18 @@ ProzillaOS uses the package manager [pnpm](https://pnpm.io/) to run scripts. > [!TIP] > Use `pnpm --filter
pnpm run site:start| [`pnpm run start`](./packages/demo/README.md#scripts) -|
pnpm run site:build| [`pnpm run build`](./packages/demo/README.md#scripts) -|
pnpm run site:preview| [`pnpm run preview`](./packages/demo/README.md#scripts) -|
pnpm run site:stage| [`pnpm run stage`](./packages/demo/README.md#scripts) -|
pnpm run site:deploy| [`pnpm run deploy`](./packages/demo/README.md#scripts) -|
pnpm run site:fetch| [`pnpm run fetch`](./packages/demo/README.md#scripts) +|
pnpm run demo:start| [`pnpm run start`](./packages/demo/README.md#scripts) +|
pnpm run demo:build| [`pnpm run build`](./packages/demo/README.md#scripts) +|
pnpm run demo:preview| [`pnpm run preview`](./packages/demo/README.md#scripts) +|
pnpm run demo:stage| [`pnpm run stage`](./packages/demo/README.md#scripts) +|
pnpm run demo:deploy| [`pnpm run deploy`](./packages/demo/README.md#scripts) +|
pnpm run demo:fetch| [`pnpm run fetch`](./packages/demo/README.md#scripts) -### Package: `prozilla-os-docs` +### Internal package: `@prozilla-os/docs` | Script | Linked package script | | --- | --- | diff --git a/package.json b/package.json index 53c2189..7107cdc 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "prozilla-os-monorepo", + "name": "@prozilla-os/monorepo", "private": true, "author": { "name": "Prozilla", @@ -10,24 +10,24 @@ "type": "module", "scripts": { "preinstall": "npx only-allow pnpm", - "start": "pnpm run site:start", + "start": "pnpm run demo:start", "prebuild": "rimraf dist", - "build": "pnpm run packages:build && pnpm run docs:build && pnpm run site:build", + "build": "pnpm run packages:build && pnpm run docs:build && pnpm run demo:build", "predeploy": "rimraf dist", - "deploy": "pnpm run docs:build && pnpm run docs:stage && pnpm run site:deploy", + "deploy": "pnpm run docs:build && pnpm run docs:stage && pnpm run demo:deploy", "publish": "pnpm vite-node packages/demo/scripts/deploy", - "site:start": "pnpm --filter prozilla-os-demo run start", - "site:build": "pnpm --filter prozilla-os-demo run build", - "site:preview": "pnpm --filter prozilla-os-demo run preview", - "site:stage": "pnpm --filter prozilla-os-demo run stage", - "site:deploy": "pnpm --filter prozilla-os-demo run deploy", - "site:fetch": "pnpm --filter prozilla-os-demo run fetch", - "docs:start": "pnpm --filter prozilla-os-docs run start", - "docs:build": "pnpm --filter prozilla-os-docs run build", - "docs:stage": "pnpm --filter prozilla-os-docs run stage", - "docs:preview": "pnpm --filter prozilla-os-docs run preview", - "docs:generate": "pnpm --filter prozilla-os-docs run generate", - "packages:build": "pnpm -r --sequential --filter @prozilla-os/* --filter prozilla-os build", + "demo:start": "pnpm --filter @prozilla-os/demo run start", + "demo:build": "pnpm --filter @prozilla-os/demo run build", + "demo:preview": "pnpm --filter @prozilla-os/demo run preview", + "demo:stage": "pnpm --filter @prozilla-os/demo run stage", + "demo:deploy": "pnpm --filter @prozilla-os/demo run deploy", + "demo:fetch": "pnpm --filter @prozilla-os/demo run fetch", + "docs:start": "pnpm --filter @prozilla-os/docs run start", + "docs:build": "pnpm --filter @prozilla-os/docs run build", + "docs:stage": "pnpm --filter @prozilla-os/docs run stage", + "docs:preview": "pnpm --filter @prozilla-os/docs run preview", + "docs:generate": "pnpm --filter @prozilla-os/docs run generate", + "packages:build": "pnpm -r --sequential --filter prozilla-os... build", "packages:update": "npx changeset && pnpm changeset version", "packages:release": "pnpm changeset publish" }, diff --git a/packages/demo/README.md b/packages/demo/README.md index de33b28..08e89dd 100644 --- a/packages/demo/README.md +++ b/packages/demo/README.md @@ -15,7 +15,7 @@ **🔗 [os.prozilla.dev](https://os.prozilla.dev/)** -`prozilla-os-demo` is a React Vite website that demonstrates the features of ProzillaOS. +`@prozilla-os/demo` is a React Vite website that demonstrates the features of ProzillaOS. ## Scripts diff --git a/packages/demo/package.json b/packages/demo/package.json index 495efd0..da58da4 100644 --- a/packages/demo/package.json +++ b/packages/demo/package.json @@ -1,5 +1,5 @@ { - "name": "prozilla-os-demo", + "name": "@prozilla-os/demo", "private": true, "author": { "name": "Prozilla", diff --git a/packages/docs/README.md b/packages/docs/README.md index 1f30a12..203bd51 100644 --- a/packages/docs/README.md +++ b/packages/docs/README.md @@ -15,7 +15,7 @@ **🔗 [os.prozilla.dev/docs](https://os.prozilla.dev/docs)** -`prozilla-os-docs` is a VitePress website that contains the documentation for ProzillaOS. +`@prozilla-os/docs` is a VitePress website that contains the documentation for ProzillaOS. ## Scripts diff --git a/packages/docs/package.json b/packages/docs/package.json index 3b8bf91..0652798 100644 --- a/packages/docs/package.json +++ b/packages/docs/package.json @@ -1,5 +1,5 @@ { - "name": "prozilla-os-docs", + "name": "@prozilla-os/docs", "private": true, "author": { "name": "Prozilla",