jstrong
/
registry-backup
1
Fork 0
Code Issues 1 Pull Requests Projects Releases 2 Wiki Activity
Browse Source

re-generate docs

master
Jonathan Strong 2 years ago
parent
5cc252342f
commit
2f5828599d
2 changed files with 5 additions and 3 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 7
      README.md
  2. 1
      doc/just-commands.txt

7
README.md
Unescape View File

@ -102,19 +102,20 @@ Available recipes:
release-build +args='' # cargo build --release wrapper - builds registry-backup in release mode release-build +args='' # cargo build --release wrapper - builds registry-backup in release mode
release-prep release-prep
test +args='' # cargo test wrapper test +args='' # cargo test wrapper
update-readme # re-generate README.md and commit changes
verify-clean-git # verify no uncommitted 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. 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 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 ```console
$ just generate-readme $ just generate-readme

1
doc/just-commands.txt
Unescape View File

@ -9,4 +9,5 @@ Available recipes:
release-build +args='' # cargo build --release wrapper - builds registry-backup in release mode release-build +args='' # cargo build --release wrapper - builds registry-backup in release mode
release-prep release-prep
test +args='' # cargo test wrapper test +args='' # cargo test wrapper
update-readme # re-generate README.md and commit changes
verify-clean-git # verify no uncommitted changes verify-clean-git # verify no uncommitted changes

Write Preview
Loading…
Cancel
Save