Readme Generator is an application using Node.js that gathers user input to generate a professional README for their GitHub Repository.
This application is run using the user's terminal. It is invoked using the command node index.js, which will then begin to prompt the user for input regarding preferences for different sections of their README.
For the README file to be generated, users must follow the prompts in the command line interface. This provides the application with information regarding their project, which will then be used to generate the README file. Once completed with the prompts, a markdown file will generate in dist/README.md.
(Click the thumbnail above or this link to view the demonstration video on YouTube.)
If users wish to include any pictures or gifs in their project, they need to specify the name of the image or gif file when prompted by the terminal questions. Once the markdown is generated, users will need to add their image files to the dist/images/ directory, ensuring that the file name of their image matches what they entered in the prompts. It is also important to note that you must use single quotes instead of double quotes in the image section.
- Open the command line interface.
- Clone the repository onto your local machine using the
git clonecommand. - Once the repository has been cloned, navigate into the root direcotry of the application using the command
cd Readme-Generator. - Run the command
npm installto install necessary packages and dependencies. - Once the dependencies have been properly installed, enter the command
node index.jsto initiate the application. - Navigate through the prompts in your command line interface using your keyboard.
- If you entered "y" to any of the prompts regarding adding images or gifs to your readme, you will need to manually add those image files to
dist/images/, ensuring that the name of the image entered in the prompts matches the name of the image file. - Once completed, your README will generate automatically with the information you entered. Open
dist/README.mdto see your generated README file.
- JavaScript
- Node.js
- npm
In the future, I would like to add the following improvements:
- I would like to somehow add a more streamlined way of adding image or gif files to the project rather than the user having to manually add their images to the
dist/images/directory every time.
I'm always interested in refactoring code to improve it's functionality. If you would like to suggest your own improvements, you can reach me at the links below.
This project was built with the help of the University of Oregon's Coding Boot Camp.
The application is covered under the following license: MIT