1 - Description
2 - Installation Instructions
3 - Usage
4 - Tools
This is a simple command-line application to help user generate a good quility README markdown file based on user's input. User will promted with a few questions. After answering them, READMEDEMO.md file will generated in the root directory.
MacOS users:
- Make sure you have HomeBrew installed on Mac
- Install npm by running "brew install npm"
- Clone or download the project and navigate to repository directory by using command line
- In order to resolve dependencies run "npm i"
- From root directory run command "node index.js"
- Answer all questions from terminal. Some questions will be opened in editor mode, (for Mac users it will be vim) in order to start typing press key "i". Upon completion press "ESC" key and ":x!" to exit
- When done, markdown file will be generated
Here is short walkthrough video click here
Here are samples of how command line looks like and sample README file:
This application was developed using Node JS. "fs" module was used to interact with file system. "Inquirer" module was used to promt questions on command line. Visual Studio code was used as a IDE.