Skip to content

Commit 301ee24

Browse files
authored
Fix heading formatting in README.md
Updated headings in the README file to improve formatting and clarity.
1 parent 86ee928 commit 301ee24

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,17 @@ 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.
1616
This file will be used as the entry point for webpack.
1717

18-
## Installation
18+
## > Installation
1919

2020
```shell
2121
npm install
2222
```
2323

2424
`npm install` will install all the dependencies required to run this project.
2525

26-
## Linting
26+
## > Linting
2727

28-
### Linting TypeScript
28+
### >> Linting TypeScript
2929

3030
```shell
3131
npm run lint:ts
@@ -34,7 +34,7 @@ npm run lint:ts
3434
`npm run lint:ts` will lint the TypeScript source code using ESLint, identifying syntactic and stylistic errors based on a configured set of rules.
3535
TypeScript linting configurations and rules can be found, edited, and updated in `eslint.config.ts.mjs`.
3636

37-
### Linting JavaScript
37+
### >> Linting JavaScript
3838

3939
```shell
4040
npm run lint:js
@@ -43,9 +43,9 @@ npm run lint:js
4343
`npm run lint:js` will lint the JavaScript configuration files using ESLint, identifying syntactic and stylistic errors based on a configured set of rules.
4444
JavaScript linting configurations and rules can be found, edited, and updated in `eslint.config.js.mjs`.
4545

46-
## Building
46+
## > Building
4747

48-
### Development Mode
48+
### >> Development Mode
4949

5050
```shell
5151
npm run build:dev
@@ -55,7 +55,7 @@ npm run build:dev
5555
This should identify any compiler errors present in your source code.
5656
The webpack build configuration can be found in `webpack.config.cjs`.
5757

58-
### Production Mode
58+
### >> Production Mode
5959

6060
```shell
6161
npm run build:prod
@@ -64,7 +64,7 @@ npm run build:prod
6464
`npm run build:prod` will bundle your sketch in production mode using webpack.
6565
The webpack build configuration can be found in `webpack.config.cjs`.
6666

67-
### Development Mode with Single File Output
67+
### >> Development Mode with Single File Output
6868

6969
```shell
7070
npm run build:dev:single-file
@@ -75,7 +75,7 @@ The resulting bundle will have your source code and all its dependencies in a si
7575
This should identify any compiler errors present in your source code.
7676
The webpack build configuration can be found in `webpack.single-file.config.cjs`.
7777

78-
### Production Mode with Single File Output
78+
### >> Production Mode with Single File Output
7979

8080
```shell
8181
npm run build:prod:single-file
@@ -85,33 +85,33 @@ npm run build:prod:single-file
8585
The resulting bundle will have your source code and all its dependencies in a single JavaScript file.
8686
The webpack build configuration can be found in `webpack.single-file.config.cjs`.
8787

88-
## Serving
88+
## > Serving
8989

90-
### Serving the Development Bundle
90+
### >> Serving the Development Bundle
9191

9292
```shell
9393
npm run dev
9494
```
9595

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

98-
### Serving the Development Bundle with Single File Output
98+
### >> Serving the Development Bundle with Single File Output
9999

100100
```shell
101101
npm run dev:single-file
102102
```
103103

104104
`npm run dev:single-file` will bundle the sketch in development mode with `webpack.single-file.config.cjs`, start a localhost development server (`127.0.0.1:8080`), and open a new browser window for the `index.html` file bundled with the compiled sketch.
105105

106-
### Serving the Production Bundle
106+
### >> Serving the Production Bundle
107107

108108
```shell
109109
npm run dev:prod
110110
```
111111

112112
`npm run dev:prod` will bundle the sketch in production mode, start a localhost development server (`127.0.0.1:8080`), and open a new browser window for the `index.html` file bundled with the compiled sketch.
113113

114-
### Serving the Production Bundle with Single File Output
114+
### >> Serving the Production Bundle with Single File Output
115115

116116
```shell
117117
npm run dev:prod:single-file

0 commit comments

Comments
 (0)