Add readme command - #139
Conversation
Stil need to figure out best command and a way to fill in some of these placeholders automatically.
|
From slack: I think neil add readme is a reasonable choice to start with. If we need to add more we can group it under neil doc whatever later |
|
I'm not sure about creating a whole version update mechanism in this PR, but maybe I could add a placeholder so people who use the command now can benefit from version updates in the future. |
|
@alysbrooks Yeah, out of scope for this one I'd say, just a future idea |
|
I created #157 to document the original idea so we don't have to rely on Slack. |
No need to introduce a new subcommand.
|
I could autogenerate instructions for adding it as a dependency to Leiningen, Boot, and the Clojure CLI, but I'm not sure where the group id should come from |
|
group id comes from |
Added a command to create a project README like I proposed in Clojurians Slack.
This is a straightforward change in terms of code. The main questions are more about ergonomics and the interface rather than technical or implementation details:
docssubcommand (like it is now) or shouldreadmebe a top-level command?add readmewas @borkdude's suggestionREADME and README templates I checked
Template
This PR corresponds to an issue with a clear problem statement : Add a command to create README #157
I have updated the CHANGELOG.md file with a description of the addressed issue.