Crafting a compelling GitHub profile is crucial for developers, showcasing their work to peers and potential employers. An often underestimated aspect of this is the README file.
A README can be the difference between a good and a bad project. A well-crafted one seizes the opportunity to clarify the application's purpose, showcase its technologies, and discuss challenges faced and future features ideas.
There's no singular formula for a perfect README, but omitting one entirely is not advised.
Enter the README generator. No more starting from scratch; just answer a few questions and a professional README will be generated.
Steps to kickstart the project:
1. Copy Link: Hit the "Code" button in this GitHub repo to copy the link.
2. Clone: In GitBash, execute the command git clone [paste link here].
3. NPM: Install Node Package Manager with npm init -y.
4. Inquirer: Get npm's inquirer package by running npm install inquirer.
Once the software is downloaded and Node packages are initialized, let's begin!
Navigate to the project directory and initiate prompts using node index.js.
Then, simply input the necessary project information, and voila! A new README file will be generated.
Link to video demo of README Generator
License Guide
This project is licensed under the ISC License - see the LICENSE.md file for details.
Please enter a new issue in the GitHub repo. Thanks!
This project does not have any tests yet.
GitHub Profile
If you have additional questions, please email me at ah@andrewhamerly.com.
None