A high-quality README allows a developer or user to get a summary of your project and engages other developers to contribute to that project. To save a project creator time on manually creating a README file, you can easily and quickly generate a README using a command-line application. By doing the following, a project creator can devote more time working on projects.
Please install the following dependencies to run the application.
- Do a git clone on this repo.
- Download Node.js and create a file system in vs code.
- From your command line, type "npm init -y".
- Then type "npm install inquirer".
- Create index.js file.
In order to use this application, the following requirements are met when:
- The command-line prompts the user to enter the project title.
- The next prompt asks what the project is about.
- Prompts what the user needs to install to run the application.
- Then asks what the instructions are to begin using the application.
- Followed by the licensing the project is covered under.
- Different ways for other developers to contribute.
- How a user can test the application.
- A contact information of the github username and email address of the project creator.
readme-walkthrough.mp4
This project is covered under MIT.
Contribution guidelines:
To contribute, read the installation section.
In the integrated terminal, type "node index.js".
For inquiries about the repo, you can find me through GitHub at inna-arabejo.
For any additional questions, you can reach me through email at iarabejo3@gmail.com.