Skip to content

Add readme command - #139

Draft
alysbrooks wants to merge 6 commits into
babashka:mainfrom
alysbrooks:alys/add-readme-command
Draft

Add readme command#139
alysbrooks wants to merge 6 commits into
babashka:mainfrom
alysbrooks:alys/add-readme-command

Conversation

@alysbrooks

@alysbrooks alysbrooks commented Jan 6, 2023

Copy link
Copy Markdown
Contributor

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:

  • Should we create a docs subcommand (like it is now) or should readme be a top-level command? add readme was @borkdude's suggestion
  • Can we fill in more information automatically?
  • Could we prompt for more information? (Maybe a follow up PR?)

README and README templates I checked

Template

@borkdude

Copy link
Copy Markdown
Contributor

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
8:18 PM
I think a cool feature would be to auto-update the version in a README, as the version is saved in deps.edn :aliases :neil :project :version
8:18 PM
but perhaps that's a bit of a stretch
8:20 PM
but the general idea seems ok to me
8:21 PM
I'd call the command neil add readme for now

@alysbrooks

Copy link
Copy Markdown
Contributor Author

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.

@borkdude

Copy link
Copy Markdown
Contributor

@alysbrooks Yeah, out of scope for this one I'd say, just a future idea

@alysbrooks

Copy link
Copy Markdown
Contributor Author

I created #157 to document the original idea so we don't have to rely on Slack.

No need to introduce a new subcommand.
@alysbrooks

Copy link
Copy Markdown
Contributor Author

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

@borkdude

Copy link
Copy Markdown
Contributor

group id comes from :aliases :neil :project :name and the namespace thereof I think?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants