Consider including README.md in NewAdvancedPowerShellModule

[RamblingCookieMonster]

Hi!

From my perspective, every module (whether you house it on GitHub, an internal system, anywhere) should have a README.md to at the very least, provide:

• What is this
• Prerequisites
• How to install
• Example(s) of common scenario(s)

Also... less critical, but potentially helpful, you might consider some basic simple format folks can start from (perhaps including a common install/discovery snippet with Install-Module ModuleName, Get-Help about_ModuleName, Get-Command -Module ModuleName`, etc.

Cheers!

[rkeithhill]

Would you want that in the current, basic new module template? Keep in mind we can create several new module templates and we probably should e.g. Personal Module template (does not plan to distribute), Shared Module template (share locally), Published Module template (share with world). We don't want to go too crazy with some Chinese menu of new module templates but I can definitely see the need for more than one.

Of course, some of these options could be managed by template parameters but @daviwil and I came to the conclusion that somewhere around 6 parameters is probably all you want to have. No one wants to have to answers 20 questions for a very basic module template. :-)

[daviwil]

Hey Warren, does this mean you're actually using (or intend do use) the template? If so, that's great! We really need to get back to working on this. Side note, Keith and I are about to bring psake back from the dead so we should be able to do even more cool stuff with Plaster + psake :)

[RamblingCookieMonster]

Hiyo!

Sorry, missed these in the flurry of pre-summit planning!

Keith - yeah, probably wouldn't make sense for a barebones no-scaffolding-whatsoever template, if you make one. I might be too gung-ho on the thou-shalt-use-a-source-control-platform thing - I would hope every personal, shared, and public module would be stored in something like GitHub/GitLab/something that displays a README... but again, I'm probably being too optimistic. So! I would definitely like to see it in any shared and public templates, if that makes sense to you all.

Agreed on keeping parameter count low; defaults help, but too many questions might annoy / confuse / turn away folks

David - used it in a sample demo template in the module session at the summit - depending on how things turn out, absolutely, might end up using them. Or I might keep trying different things and end up with / continue to have a dozen modules each with different scaffolding : P

Cheers!

[ngetchell]

@daviwil What do you mean bring back psake?

[daviwil]

@RamblingCookieMonster I definitely believe a README is necessary, even better if we have a good standard format that people can start from.

@ngetchell Keith and I are taking over maintainership of psake since it hasn't been moving for a while. No specific plans yet but we'll start a discussion about it soon!