The README File Generator is a command-line application that useses node.js to help developers quickly create professional README files for their projects. By prompting you with a series of questions using the inquirer package about your project details, such as the installation, usage, technologies, screenshots, walkthrough video, UR link, contributiong, contributors, test, license and questions are used to automatically compiles this information into a well-structured README. This not only saves time but also ensures that your project documentation is consistent and informative, making it easier for others to understand and contribute to your work.
- Installation
- Usage
- Technologies
- Screenshots
- Walkthrough Video
- URL Link
- Contributing
- Contributors
- Tests
- License
- Questions
-
Git clone: git@github.com:Treevyy/README-File-Generator.git
-
Navigate to the project directory: cd README-File-Generator
-
Right click the root package.json file and click open in integrated terminal
-
Inside the terminal install the dependencies with the command: npm i
-
After dependencies are installed run the application with the command: node index.js
To generate your README file:
-
Run the application using node index.js in your terminal.
-
Answer the interactive prompts with details about your project, such as the project title, description, installation process, usage guidelines, and any additional information you wish to include.
-
Once all prompts are completed, the generator will create a new README file in your project directory.
-
Open and review the generated README to ensure it meets your expectations and make any custom edits if necessary.
A demo of the application can be found at the following link: https://drive.google.com/file/d/1ypGWTxIBea_0EZGGuwxYkWO1SCozieXw/view
There is no URL link to this application
No contributions are needed for this project
Trevor Moore aka Treevyy
Make sure the latest version of node is installed, check by using the command: node -v in your terminal
Then run the command: node index.js inside the terminal to test the application
This project is licensed under the MIT license.
If you have any additonal questions, you can contact me at:
- GitHub: Treevyy
- Email: aarontrevormoore@gmail.com