From 5ae7ba122c0c24d9e3b3a8aef3a096686dac1568 Mon Sep 17 00:00:00 2001 From: Alan Ye Date: Wed, 28 Aug 2024 20:45:11 +0800 Subject: [PATCH] docs: command usage and license --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index d7284c6..1db0ea3 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,24 @@ # c13n The newsletter of Computerization. +## Commands + +We use `pnpm` as `c13n`'s package manager. Please avoid the usage of `npm` command. + +| Command | Action | +|:---------------------------| :----------------------------------------------- | +| `pnpm install` | Installs dependencies | +| `pnpm run dev` | Starts local dev server at `localhost:4321` | +| `pnpm run dev:network` | Starts local dev server on local network | +| `pnpm run sync` | Generates TypeScript types for all Astro modules.| +| `pnpm run build` | Build your production site to `./dist/` | +| `pnpm run preview` | Preview your build locally, before deploying | +| `pnpm run preview:network` | Preview build on local network | +| `pnpm run astro ...` | Run CLI commands like `astro add`, `astro check` | +| `pnpm run astro -- --help` | Get help using the Astro CLI | +| `pnpm run lint` | Run ESLint | +| `pnpm run lint:fix` | Auto-fix ESLint issues | + +## License + +MIT for source code, CC BY 4.0 for texts. \ No newline at end of file