From 186bc151c3ee2841b34f868f26c03fff0c1681db Mon Sep 17 00:00:00 2001 From: satnaing Date: Sun, 24 Sep 2023 17:38:58 +0630 Subject: [PATCH] docs: update README for v3 Update file structure section. Add concurrent command running method for Windows PowerShell users. Update footer credit to acknowledge the contributions of other contributors. resolve #113 --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 870380e..6404e7a 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,6 @@ Inside of AstroPaper, you'll see the following folders and files: │ ├── content/ │ │ | blog/ │ │ | └── some-blog-posts.md -│ │ └── _schemas.ts │ │ └── config.ts │ ├── layouts/ │ └── pages/ @@ -140,6 +139,8 @@ All commands are run from the root of the project, from a terminal: | `npm run cz` | Commit code changes with commitizen | | `npm run lint` | Lint with ESLint | +> Warning! Windows PowerShell users may need to install the [concurrently package](https://www.npmjs.com/package/concurrently) if they want to [run diagnostics](https://docs.astro.build/en/reference/cli-reference/#astro-check) during development (`astro check --watch & astro dev`). For more info, see [this issue](https://github.com/satnaing/astro-paper/issues/113). + ## ✨ Feedback & Suggestions If you have any suggestions/feedback, you can contact me via [my email](mailto:contact@satnaing.dev). Alternatively, feel free to open an issue if you find bugs or want to request new features. @@ -150,4 +151,4 @@ Licensed under the MIT License, Copyright © 2023 --- -Made with 🤍 by [Sat Naing](https://satnaing.dev) 👨🏻‍💻 +Made with 🤍 by [Sat Naing](https://satnaing.dev) 👨🏻‍💻 and [contributors](https://github.com/satnaing/astro-paper/graphs/contributors).