Skip to content

Commit

Permalink
BUG: $ prefix in copied command
Browse files Browse the repository at this point in the history
* Make commands copy-pasteable.
* Describe the commands better.
  • Loading branch information
Joppe committed Mar 26, 2024
1 parent d9917d5 commit 240293e
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,34 @@

---

Run this in your project directory:

```
$ GH="https://raw.githubusercontent.com"; curl $GH/joakimbits/normalize/main/template/Makefile -o Makefile && make
GH="https://raw.githubusercontent.com"; curl $GH/joakimbits/normalize/main/template/Makefile -o Makefile && make
```

- Create executables from all source files.
- Creates executables from all source files.
- Recursively also in sub-directories with a README.md file, or any other .md file.

---

Test and document your project:

```
$ make pdf html slides
make pdf html slides
```

- Tests all usage examples, and generates project reports if they all PASS.

---

Changes since your last release, with release notes:

```
$ make old new review audit
make old new review audit
```

- Analyze changes and use GPT to generate release notes.
- Analyze changes and use GPT to audit them.

---

Expand Down

0 comments on commit 240293e

Please sign in to comment.