Skip to content

Commit

Permalink
Add notes about quick-and-dirty README.md generation
Browse files Browse the repository at this point in the history
  • Loading branch information
ipmb committed Feb 10, 2024
1 parent 4611337 commit 464e79b
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,17 @@ To use `django-layout`:
--exclude=.github \
YOUR_PROJECT_NAME

## Development

To update `README.md` after making changes to the config, run:

```
find . -type f -name "*.py" -or -name Makefile -or -name README.md | xargs sed -i '' 's/{{ project_name }}/project_name/g'
docker compose run --rm --no-deps app make README.md
```

Then use `git add -p README.md` to only commit the changes you want. You can `git stash` the template changes after your commit.

*Note: The text following this comment block will become the README.md of the new project.*

------------------------------------------------------------------------
Expand Down

0 comments on commit 464e79b

Please sign in to comment.