Skip to content
This repository has been archived by the owner on Jun 14, 2024. It is now read-only.

Mention usage in README #56

Open
FranklinYu opened this issue Jan 16, 2019 · 0 comments
Open

Mention usage in README #56

FranklinYu opened this issue Jan 16, 2019 · 0 comments

Comments

@FranklinYu
Copy link

FranklinYu commented Jan 16, 2019

The README did not provide any information for package user. I have searched around, even looking into the doc folder without understanding anything, until I see the template directory with very useful information.

It would be cool if this template is mentioned in README so user can get started in 10 seconds. Typically README is for library consumers (developer writing PowerShell modules); sections like "Building PowerShell Standard Libraries" should in fact go into CONTRIBUTING.md or at lease grouped under "Contributing" section.

Alternatively we can link to this awesome documentation.

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

No branches or pull requests

1 participant