Skip to content

Commit 7ee57c8

Browse files
committed
dev: mention need to manually rebuild assets
fix typo
1 parent f33168b commit 7ee57c8

1 file changed

Lines changed: 9 additions & 2 deletions

File tree

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,17 @@ the Arch Linux package statistics website.
1212

1313
# Setup
1414
1. Run `just init` to install dependencies, build and generate fixtures
15-
2. Run `just run` to start the application locally or `just dev` to watch for template and Go changes and rebuild automatically (requires [air](https://github.com/air-verse/air))
15+
2. Run `just run` to start the application locally
1616
3. Run `just` for a full list of available commands
1717

18-
# Contributions
18+
# Contributing
19+
## Dev Mode
20+
Run `just dev` to watch for template and Go changes and rebuild automatically (requires [air](https://github.com/air-verse/air)).
21+
The automatic rebuild does not include assets (images, JS, CSS) and all unused classes are stripped during the build process.
22+
Thus, when changing classes for example, you might need to stop the dev server and run `just build-assets` and then start
23+
the project again.
24+
25+
## Tests
1926
For contributing you'll probably want to test your changes at least once
2027
before submitting a pull request. Run `just test` to run all tests.
2128

0 commit comments

Comments
 (0)