Skip to content

Commit

Permalink
Update 'how to' description.
Browse files Browse the repository at this point in the history
Co-authored-by: rmsmith251 ryanmsmith251@gmail.com
Co-authored-by: fkodom frank.odom.iii@gmail.com
  • Loading branch information
fkodom committed Aug 11, 2023
1 parent 58f579d commit ae9e570
Showing 1 changed file with 16 additions and 15 deletions.
31 changes: 16 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit ae9e570

Please sign in to comment.