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

Generate a README.md file #587

Open
silvenon opened this issue Nov 5, 2016 · 5 comments
Open

Generate a README.md file #587

silvenon opened this issue Nov 5, 2016 · 5 comments
Assignees
@UlisesGascon
Labels
enhancement
Milestone
v4.0.0

Comments

@silvenon
Copy link
Member

silvenon commented Nov 5, 2016

It would be great if the generator also created the README.md file, which would contain instruction about how to use the project.

Idea inspired by create-react-app.
@s3c0nDD
Copy link

s3c0nDD commented Mar 19, 2017

oh i think this issue should be closed now ?

@silvenon
Copy link
Member Author

@s3c0nDD what do you mean? We don't generate a README.md yet.

@s3c0nDD
Copy link

s3c0nDD commented Mar 21, 2017

@silvenon but what's this?

@silvenon
Copy link
Member Author

silvenon commented Mar 21, 2017 •
edited

This is the README of the generator-webapp project. This issue was referring to the customized README generated by the yo webapp command (which doesn't exist yet). Instead of people having to look in this project's README for usage instructions, they would have it right there in the scaffolded files.

@silvenon silvenon pinned this issue Jan 10, 2019
@UlisesGascon UlisesGascon mentioned this issue Jun 3, 2019
Open
15 tasks
@UlisesGascon UlisesGascon added this to the v4.1.0 milestone Jun 3, 2019
@UlisesGascon UlisesGascon unpinned this issue Jun 3, 2019
@UlisesGascon UlisesGascon self-assigned this Oct 28, 2019
@UlisesGascon
Copy link
Member

I can handle it. I made something similar for another generator. I will rise a PR soon

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

@UlisesGascon UlisesGascon

Labels
enhancement
Projects
None yet
Milestone
v4.0.0
Development

No branches or pull requests
3 participants
@silvenon @UlisesGascon @s3c0nDD