fuzzyworld

template / commit

Added info about makefile to Readme.

1993289f72726c703c891fe607e5d98104d4a327 · Pavel Safronov · 2022-11-16 10:28:11 -0800 · parents a2aa5f429161

Added info about makefile to Readme.
 README.md | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/README.md b/README.md
index 70b2c9b..143d8a8 100644
--- a/README.md
+++ b/README.md
@@ -148,6 +148,15 @@ Here are the basic features of the CLI that I want to keep:
 
 I want to keep this CLI simple. To that extent, I'm not interested in adding too many features. My main requirement right now is: `template blog topic` should do the same thing as `template --profile blog --name topic`.
 
+### VSCode and make
+
+Good guidance is invaluable, IMO, so to this extent I am very bullish about adding and using descriptive Makefile and VS Code launch tasks.
+
+Makefile should be used for any build/test/release task. If there is a reason to run a task more than once *in the lifetime of a project*, add the task to the Makefile with a descriptive name.
+I don't want to see complicated steps embedded in READMEs or (worse) in code. If the task is important, one that a maintainer/developer/user *may* want to do, add it to Makefile.
+
+Similarly, if there is a good VSCode debug scenario, add a task to launch.json.
+
 ### Future Features
 
 Here is the future feature list: