diff --git a/README.md b/README.md index e49ea904..2689b108 100644 --- a/README.md +++ b/README.md @@ -17,15 +17,20 @@ Requirements for developing: ## Commands -| Command | Description | -|---------------|-----------------------------------------------------------------------------------| -| nvm use | Uses correct Node version chosen for the theme compiler. | -| npm i | Install dependencies and link local packages. | -| npm ci | Install a project with a clean slate. Use especially in travis like environments. | -| npm run dev | Compile styles and js for development environment. and watch file changes. | -| npm run build | Build packages for production. Minify CSS/JS. | - -Set up the developing environment by running +| Command | Container command | Description | +|---------------|-------------------------|-----------------------------------------------------------------------------------| +| nvm use | N/A | Uses correct Node version chosen for the theme compiler. | +| npm i | make install-hdbt-admin | Install dependencies and link local packages. | +| npm ci | N/A | Install a project with a clean slate. Use especially in travis like environments. | +| npm run dev | make watch-hdbt-admin | Compile styles and js for development environment. and watch file changes. | +| npm run build | make build-hdbt-admin | Build packages for production. Minify CSS/JS. | + +Consistent Node version defined in `.nvmrc` should be used. For development, use either `nvm` to select the correct +version or `make` commands that select the version automatically. Run `make` the commands from the table above in the +project directory of your instance. For more information, see +[build-assets.md](https://github.com/City-of-Helsinki/drupal-helfi-platform/blob/main/documentation/build-assets.md). + +Set up the developing environment with `nvm` by running nvm use npm i