Skip to content

Commit 0dc8f54

Browse files
authored
Update README.md
1 parent 93a7b51 commit 0dc8f54

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,36 +5,36 @@ A template project for using
55
with
66
[TypeScript](https://www.typescriptlang.org/)
77
and
8-
[Webpack](https://webpack.js.org/).
8+
[webpack](https://webpack.js.org/).
99

10-
# Getting Started
10+
## Getting Started
1111

1212
Create a new project from this template using the green "Use this template" button above.
1313

1414
Write the project's source code in the `src/` directory.
1515
The `src/sketch.ts` file provided contains a simple p5.js program with a black background and a white circle.
16-
This file will be used as the entry point for the bundler.
16+
This file will be used as the entry point for webpack.
1717

1818
```shell
1919
npm run lint
2020
```
2121

22-
`npm run lint` will lint the source code, identifying syntactic and stylistic errors based on a configured set of rules.
22+
`npm run lint` will lint the source code using ESlint, identifying syntactic and stylistic errors based on a configured set of rules.
2323
Linting configurations and rules can be found, edited, and updated in `eslint.config.mjs`.
2424

2525
```shell
2626
npm run build
2727
```
2828

29-
`npm run build` will bundle your sketch in development mode.
29+
`npm run build` will bundle your sketch in development mode using webpack.
3030
This should identify any compiler errors present in your source code.
3131

3232
```shell
3333
npm run dev
3434
```
3535

3636
`npm run dev` will bundle the sketch in development mode,
37-
start a localhost development server (127.0.0.1:8080),
37+
start a localhost development server (`127.0.0.1:8080`),
3838
and open a new browser window for the `index.html` file bundled with the compiled sketch.
3939

4040
```shell
@@ -43,20 +43,20 @@ npm run prod
4343

4444
`npm run prod` will create a production-ready bundle of the source code.
4545

46-
# GitHub Workflows
46+
## GitHub Workflows
4747

4848
This template contains GitHub workflows designed to update project dependencies monthly.
4949
To learn more about dependabot configurations, visit the
5050
[GitHub Dependabot documentation](https://docs.github.com/en/code-security/dependabot).
5151

52-
# Attributions
52+
## Attributions
5353

5454
The favicon.ico of this template was designed by
5555
[Freepik from Flaticon](https://www.flaticon.com/free-icons/art).
5656
You can find the original icon on
5757
[flaticon.com](https://www.flaticon.com/free-icon/art_1756752?term=art&page=1&position=38&origin=search&related_id=1756752).
5858

59-
# LICENSE
59+
## LICENSE
6060

6161
The source code of this project is licensed under the
6262
[GNU Affero General Public Version 3.0 License](https://www.gnu.org/licenses/agpl-3.0.en.html).

0 commit comments

Comments
 (0)