When creating an open source project on GitHub, it’s important to have a high-quality README for the app. This command-line application allows users generate their own readme files based on their responses to specific prompted questions. This includes what the app is for, how to use the app, how to install it, how to report issues, and how to make contributions. It lets users save time while simultaneously making their projects more complete and professional!
Download the zip file from this repository or clone it directly to a directory of your choice. Open the file in VS Code or any other editor. Using the terminal, set yourself in the right root directory and run the app. It is recommended to have node.js installed.
After installation is complete, run the following code: ‘node inex.js’ in the terminal. Answer the questions prompted and after completion, a message that says ‘File written successfully’ should be displayed. Your readme file will be created under your file directory. You should see a file called ‘(your project title)-README’.
The application is covered under the following license: ISC
For the moment this project does not accept contributions from third parties. Thank you for your interest.
To test this app, open up the file in VS Code. Open the terminal, change directory into the root folder of your choice, and run ‘node index.js’. Answer the prompts and view the preview your project ‘README.md’.
Please contact me using the following links: