From 0759598a627513650915eb42315cdc4b000a62a0 Mon Sep 17 00:00:00 2001 From: David Linke Date: Wed, 8 Jan 2025 00:12:00 +0100 Subject: [PATCH] Update READMEs for just --- README.md | 8 ++++++++ {{cookiecutter.project_name}}/README.md | 9 +++++---- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 60038c8..ecd30a2 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,14 @@ The following are required and recommended tools for using this cookiecutter and ``` You may also choose to not have a persistent installation of cruft, in which case you would replace any calls to the `cruft` command below with `pipx run cruft`. + + * **make or just as command runner** + + The project contains a makefile but also a `justfile` with pre-defined complex commands. To execute these commands you either need `make` or [just](https://github.com/casey/just) as an alternative command runner. Especially for Windows users we suggest `just`. Install it by running: + ```shell + pipx install just + ``` + ## Creating a new project ### Step 1: Generate the project files diff --git a/{{cookiecutter.project_name}}/README.md b/{{cookiecutter.project_name}}/README.md index 6d7742d..82e3411 100644 --- a/{{cookiecutter.project_name}}/README.md +++ b/{{cookiecutter.project_name}}/README.md @@ -23,10 +23,11 @@ ## Developer Documentation
-Use the `make` command to generate project artefacts: - -* `make all`: make everything -* `make deploy`: deploys site +To run commands you may use good old make or the command runner [just](https://github.com/casey/just/) which is a better choice on Windows. +Use the `make` command or `duty` commands to generate project artefacts: +* `make help` or `just --list`: list all pre-defined tasks +* `make all` or `just all`: make everything +* `make deploy` or `just deploy`: deploys site
## Credits