This application allows a user to create a professional README.md file dynamically from input entered through the command line.
- JavaScript
- Node.js
- NPM
To ensure a smooth installation of this app, please follow the instructions carefully and in order. Note that this is a command line application, so all commands must be entered in the command line (if on Windows) or Terminal (if on Mac).
- Before proceeding, please ensure that Node.js and npm are installed on your local computer. Click for more information on installation,. Download or clone the README Generator repository into your local computer.
- Create a .gitignore file and include node_modules/ so that your node_modules directory isn't uploaded to GitHub. Make sure to create the .gitignore file before moving to the next step.
- Install the inquirer npm by entering the command below in the Terminal or command line:
npm install --save inquirer
For more information on this package, please visit NPM.
To run the application:
-
Open Terminal or the command line and type the following command:
node index.js
-
You will be prompted with a series of questions; use the up and down arrow keys to navigate multiple-choice questions and hit the space bar to make a selection before hitting the enter key.
-
After all questions have been answered, you will be notified that the file has been saved to
README.md. -
Open the file and you will see that your README file has been generated.
Click Me or the image to see the full walkthrough video of the application.
This project is licensed under the MIT License. View licence
You are welcome to contribute to this project.
Do you have any questions? Would you like to collaborate on a project?
N/A