Skip to content
This repository was archived by the owner on Jun 1, 2023. It is now read-only.

Commit d5ad804

Browse files
committed
Update Development section in README.md
1 parent ee4565a commit d5ad804

File tree

1 file changed

+31
-7
lines changed

1 file changed

+31
-7
lines changed

README.md

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -244,31 +244,55 @@ jobs:
244244
```
245245
246246
## Development
247+
247248
### Web Assets
248249
249-
To make changes to the CSS files, you need to have Node and a package manager such as `npm` installed. To get started:
250+
CSS assets used by the HTML output format
251+
are processed and generated by [PostCSS](https://postcss.org).
252+
To make changes to these assets,
253+
you'll need to have [Node.js](https://nodejs.org/en/)
254+
and a package manager, such as [`npm`](https://www.npmjs.com),
255+
installed on your machine.
256+
257+
Navigate to the `.node` directory
258+
and run `npm install` to download the required tools and libraries.
250259

251260
```terminal
252261
$ cd .node
253262
$ npm install
254263
```
255264

256-
To process the PostCSS files during development:
265+
> **Note**:
266+
> `package.json` is located at a hidden `.node` subdirectory
267+
> to prevent Xcode from displaying or indexing the contents of `node_modules`
268+
> when opening the main project.
269+
270+
From the `.node` directory,
271+
run the `watch` script
272+
to start watching for changes to files in the `Assets` folder.
273+
Whenever an asset source file is added, removed, or updated,
274+
its corresponding (unoptimized) product is automatically generated
275+
in the `Resouces` folder.
257276

258277
```terminal
259-
$ cd .node
260278
$ npm run watch
261279
```
262280

263-
This will start watching the source files in `Assets` with hot-reload support, auto-generating non-optimized assets in `Resources` whenever a source file is saved.
264-
265-
Once happy with the results, run this command to create production-ready assets:
281+
When you're happy with the results,
282+
run the `build` script to generate production-ready assets.
266283

267284
```terminal
268285
$ npm run build
269286
```
270287

271-
Both the source files and the generated files are checked into this repository.
288+
Finally,
289+
commit any changes to the source files in `Assets`
290+
as well as the generated files in `Resources`.
291+
292+
```terminal
293+
$ git add Assets Resources
294+
$ git commit
295+
```
272296

273297
## License
274298

0 commit comments

Comments
 (0)