Welcome to the TroveReadme-Generator! This command-line tool for NodeJS helps you streamline README.md markdown creation in a professional and standardized format for your projects quickly and with ease.
Features
- Automatic Generation: Generate a README.md file with predefined sections title, description, installation instructions, usage, contributing credits, and Testing Instructions.
- Section that are empty will be excluded from README.md file.
- Interactive Prompts: Answer interactive prompts to provide the necessary information for each section of the README.md file.
- Save Time and Effort: Save time and effort by automating the creation of README.md files, allowing you to focus on coding and building your projects.
You can install and run the Kevins-Trove/TroveReadme-Generator package via npx:<br> - npx trovereadme-generator
- npx trovereadme-generator will create a README.md file in the current project folder.
This project is brought to you by:
- @Kevins-Trove
This project relies on the NodeJS ecosystem and we greatfully thank the developers of these libraries for their contributions to the open-source community!
To run the tests for this project, follow these steps:
1. Ensure that you have Node.js and npm installed on your system. You can download them from nodejs.org.
2. You can also clone this repository to your local machine:
- git clone https://github.com/Kevins-Trove/TroveReadme-Generator.git
Check out my work, feel free to adapt it to your needs or reach out to me directly.