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

Create a Standard Readme generator #6

Closed
RichardLitt opened this Issue May 12, 2016 · 7 comments

Comments

Projects
None yet
4 participants
@RichardLitt
Owner

RichardLitt commented May 12, 2016

This is the planning issue for the Standard Readme generator. It will most likely be based on generator-nms, a node scaffold developed by me that is based on @sindresorhus's generator-nm, using yeoman.

Please subscribe and discuss generator issues here, and open other issues for Standard Readme questions.

@RichardLitt

This comment has been minimized.

Owner

RichardLitt commented May 13, 2016

I believe that this is done, with the creation today of: https://github.com/RichardLitt/generator-standard-readme. Now I just need to link it here.

@RichardLitt RichardLitt referenced this issue May 19, 2016

Closed

Roadmap #1

8 of 18 tasks complete
@zkochan

This comment has been minimized.

zkochan commented May 21, 2016

Have you seen this package - package-json-to-readme? It doesn't follow the standard readme currently, but it has no dependency on yeoman.

I am working on a pull request to that package, that will allow to dynamically update the readme (like automatically generating the Table of Contents), and test it for correctness, using mos (for instance, test that the title, description, installation section are correct, that the usage example can be executed with no errors and a lot more)

@RichardLitt

This comment has been minimized.

Owner

RichardLitt commented May 23, 2016

I haven't, looks cool - @zeke does great work. I don't think it'll work for this project, because it is fairly npm and js specific. I'm looking for a more general standard.

mos looks cool, too, but it messes up the clean formatting of the Markdown formatting. Sure, it works on GitHub, but I'm not sure that this is what I want. I may be wrong. It also isn't as simple as just text. I think that remark-lint is probably a cleaner way forward.

@zeke

This comment has been minimized.

zeke commented May 25, 2016

👋

Sorry to keep you waiting on that PR, @zkochan. My wife just had a baby so I'm mostly offline!

@zkochan

This comment has been minimized.

zkochan commented May 25, 2016

@zeke congratulations!! 🎆

Actually the PR can wait, I want to add some improvements to it.

@balupton

This comment has been minimized.

balupton commented Jun 17, 2016

https://github.com/bevry/projectz has been around for a few years now and seems to already accomplish what this issue aims to do. It is used on all bevry and docpad repos. Plan is to extend it with a plugin system in the coming months. Happy to improve it as necessary.

RichardLitt added a commit that referenced this issue Jun 18, 2016

@RichardLitt

This comment has been minimized.

Owner

RichardLitt commented Jun 18, 2016

@balupton I disagree. That is a much more broad project. I don't think it follows the Unix philosophy of doing one thing only.

It also replaces comment tags instead of working solely with the text - something that works for GitHub, but that leads to extra code that isn't relevant (say if reading from terminal). I think that's something I want to avoid here.

Now that https://github.com/RichardLitt/generator-standard-readme exists, this can probably be closed.

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