From bd96206823c86d09adf2dbb71342a0d33e669179 Mon Sep 17 00:00:00 2001 From: Frank Odom Date: Fri, 11 Aug 2023 13:41:27 -0500 Subject: [PATCH] Update 'how to' description. Co-authored-by: rmsmith251 ryanmsmith251@gmail.com Co-authored by: fkodom frank.odom.iii@gmail.com --- README.md | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index c9ae574..cbef4e9 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,21 @@ # {{REPO_NAME}} -## Usage - -Create a new repository, using this one as a template. Then, run the `templatize` script: - -```bash -./templatize -``` - -This replaces all `{{REPO_NAME}}` and similar placeholders, so the repo is properly configured with your project name, your username and email, etc. Commit the changes, and you're ready to go! - -```bash -git add . -git commit -m "Templatize" -git push -``` +How to use this template: + +1. Create a new repository, using this one as a template. +2. Run the `templatize` script: + ```bash + ./templatize + ``` + + This updates placeholders like `{{REPO_NAME}}`, so everything is configured with your username, repo name, email, etc. +3. Commit and push the changes. + ```bash + git add . + git commit -m "Templatize" + git push + ``` +4. (Probably) delete this section of the README. ## Install