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.

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

Should create and configure a second readme for the distribution of the library #83

Closed
dbfannin opened this issue May 5, 2017 · 6 comments

Comments

@dbfannin
Copy link
Contributor

dbfannin commented May 5, 2017

I wanted to first say thanks for this great tool!

I was wanting to get thoughts on adding a readme to the src directory when initializing a new library, and copying that file over to the dist directory on build (following the same pattern as the package.json). I'm currently doing this as a manual process after I build, and it would be nice to have it automated.

@jvandemo
Copy link
Owner

jvandemo commented May 7, 2017

@dbfannin — I think that is a great idea 👍

Are you interested in creating a PR for this? Thanks in advance!

@dbfannin
Copy link
Contributor Author

dbfannin commented May 8, 2017

Sure I can do that!

@dbfannin
Copy link
Contributor Author

dbfannin commented May 8, 2017

Do you think the route should be to just copy the root readme to the dist directory, or adding a second README to the templates?

@jdjuan
Copy link
Collaborator

jdjuan commented May 8, 2017

To keep it simple, I would just leave one. It would be a responsibility of the user to create two sections within it: One for development and another one for usage! 🤓

BTW, @dbfannin thanks for taking thing one! 👍

@jvandemo
Copy link
Owner

jvandemo commented May 9, 2017

@dbfannin — The generators/app/templates/README.MD file should do. It's already being generated in the root of the generated code. Thanks in advance!

@jvandemo
Copy link
Owner

Implemented in #85 and released as v10.1.0 👍

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

No branches or pull requests

3 participants