From 2f5828599dccfdb43ecf984f065eb8331a6fbf67 Mon Sep 17 00:00:00 2001 From: Jonathan Strong Date: Thu, 8 Sep 2022 17:41:39 -0400 Subject: [PATCH] re-generate docs --- README.md | 7 ++++--- doc/just-commands.txt | 1 + 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9442b47..8ef3bd6 100644 --- a/README.md +++ b/README.md @@ -102,19 +102,20 @@ Available recipes: release-build +args='' # cargo build --release wrapper - builds registry-backup in release mode release-prep test +args='' # cargo test wrapper + update-readme # re-generate README.md and commit changes verify-clean-git # verify no uncommitted changes ``` The commands that mirror cargo commands (e.g. `just test`) are included for the purpose of convenience, so that various options (e.g. `RUSTFLAGS='-C target-cpu=native`) can be included without typing them out each time. -## Generating README.md +## Generating `README.md` This file is generated using a template (`doc/README.tera.md`) rendered using updated outputs of the CLI menu, config sample, and other values. -This version of README.md was generated at `Thu, 08 Sep 2022 21:37:48 +0000` based on git commit `ea7545dc`. +This version of `README.md` was generated at `Thu, 08 Sep 2022 21:41:39 +0000` based on git commit `5cc25234`. -To (re-)generate the README.md file, use the justfile command: +To (re-)generate the `README.md` file, use the justfile command: ```console $ just generate-readme diff --git a/doc/just-commands.txt b/doc/just-commands.txt index 79df496..70674a4 100644 --- a/doc/just-commands.txt +++ b/doc/just-commands.txt @@ -9,4 +9,5 @@ Available recipes: release-build +args='' # cargo build --release wrapper - builds registry-backup in release mode release-prep test +args='' # cargo test wrapper + update-readme # re-generate README.md and commit changes verify-clean-git # verify no uncommitted changes