This application saves time for developers by automattically creating a professional README.md file for their repository, like this one. In fact this entire README was created using this program. Through the use of Javascript and nodejs modules we are able to ask the user a series of questions regarding their repository and its contents, and create a README from their answers.

• Installation
• Usage
• Contributing
• Tests
• Qyestions
• License

In order to install this project you must first clone the repo to your local machine. Then run the command npm -install. This will install the necessary dependencies required to run the program, all of which are defined in the package.json. Once the installation is complete then run node index.js, answer all the questions with no limit to characters. Once the program is finished prompting you it will have created a README.md in the same directory. If you realize you made some mistakes you can run the program again and it will overwrite the previous README.md.

After you have spent hours coding and getting your project to work it may feel a bit tedious to create a README. For some it is as easy as answering some questions and viola your README is created. It will include headings, table of contents, licensing, badges, and even how to contact you. If you want to know how you can use this refer to the installation section

Here you can view a video tutorial

Contributors to this project are solely Nicholas Krilis. If you would like to make some changes you can fork this repository, make your additions/changes and submit your pull request(s). I will take a look and merge it if all looks good. Thank you!

For this project currently there is no testing programs, however if you give this program a go you will see everything works flawlessly.

Here you can view my Github Account

If you have any questions or would like to reach me you can contact me at [email protected]

Copyright (C) 2022  Nicholas Krilis

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see [https://www.gnu.org/licenses/].