Skip to content

Commit 93a7b51

Browse files
authored
Merge pull request #2 from blwatkins/main
Add getting started instructions
2 parents 2f4d391 + 3820c27 commit 93a7b51

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,42 @@ with
77
and
88
[Webpack](https://webpack.js.org/).
99

10+
# Getting Started
11+
12+
Create a new project from this template using the green "Use this template" button above.
13+
14+
Write the project's source code in the `src/` directory.
15+
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.
17+
18+
```shell
19+
npm run lint
20+
```
21+
22+
`npm run lint` will lint the source code, identifying syntactic and stylistic errors based on a configured set of rules.
23+
Linting configurations and rules can be found, edited, and updated in `eslint.config.mjs`.
24+
25+
```shell
26+
npm run build
27+
```
28+
29+
`npm run build` will bundle your sketch in development mode.
30+
This should identify any compiler errors present in your source code.
31+
32+
```shell
33+
npm run dev
34+
```
35+
36+
`npm run dev` will bundle the sketch in development mode,
37+
start a localhost development server (127.0.0.1:8080),
38+
and open a new browser window for the `index.html` file bundled with the compiled sketch.
39+
40+
```shell
41+
npm run prod
42+
```
43+
44+
`npm run prod` will create a production-ready bundle of the source code.
45+
1046
# GitHub Workflows
1147

1248
This template contains GitHub workflows designed to update project dependencies monthly.

0 commit comments

Comments
 (0)