generator-doc-skeleton

A Yeoman generator to create readme and wiki files based on pre-defined structure.

readme: will contain all the generic stuff
wiki: will contain all what is internal and needs to be shared between the committers of a project.

Prerequisities

Node (https://nodejs.org)
Yeoman :

npm install -g yo

Usage

1- install the generator globally

npm install -g generator-doc-skeleton

2- run the generator from your project root folder

yo doc-skeleton

Verification

you can run this command to detect potential issues with the system that could prevent Yeoman from working correctly

yo doctor

Troubleshooting

if you have a complain about the generator not being installed then please update yo globally:

npm update -g yo

Author

License

Licensed under the MIT license.

Acknowledgments

structure inspired from: Billie Thompson - readme template - PurpleBooth