Skip to content

Commit

Permalink
Update READMEs for just
Browse files Browse the repository at this point in the history
  • Loading branch information
dalito committed Jan 7, 2025
1 parent 92307c3 commit 0759598
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 4 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 5 additions & 4 deletions {{cookiecutter.project_name}}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,11 @@
## Developer Documentation

<details>
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
</details>

## Credits
Expand Down

0 comments on commit 0759598

Please sign in to comment.