Skip to content

Commit

Permalink
docs: update README for v3
Browse files Browse the repository at this point in the history
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
  • Loading branch information
satnaing committed Sep 25, 2023
1 parent 29224ab commit 192e90a
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand Down Expand Up @@ -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:[email protected]). Alternatively, feel free to open an issue if you find bugs or want to request new features.
Expand All @@ -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).

0 comments on commit 192e90a

Please sign in to comment.