Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Generated README should have project build commands first #9

Open
aantron opened this issue Jul 4, 2021 · 0 comments
Open

Generated README should have project build commands first #9

aantron opened this issue Jul 4, 2021 · 0 comments

Comments

@aantron
Copy link
Contributor

aantron commented Jul 4, 2021

Right now, the README starts with make switch and make build, both of which are unnecessary after template generation, and just make the user wonder if the deps aren't installed after all that automatic work during generation.

IMO the README should just recommend make, make start, and/or make watch. A separate section on updating deps should recommend editing the opam file and running make deps. It should be after tests and docs.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@aantron