https://github.com/andrewhamerly/readme-generator

No more starting from scratch; just answer a few questions and a professional README will be generated.
https://github.com/andrewhamerly/readme-generator

javascript markdown node node-js readme readme-generator

Last synced: 2 months ago
JSON representation

No more starting from scratch; just answer a few questions and a professional README will be generated.

• Host: GitHub
• URL: https://github.com/andrewhamerly/readme-generator
• Owner: andrewhamerly
• License: isc
• Created: 2024-04-15T17:24:50.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-18T18:09:46.000Z (about 1 year ago)
• Last Synced: 2025-01-30T01:44:10.610Z (4 months ago)
• Topics: javascript, markdown, node, node-js, readme, readme-generator
• Language: JavaScript
• Homepage:
• Size: 13.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# README Generator

  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.

  ## Table of Contents

  - [Installation](#installation)

  - [Usage](#usage)

  - [License](#license)

  - [Contributing](#contributing)

  - [Tests](#tests)

  - [Questions](#questions)

  - [Credits](#credits)

  ## Installation

  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`.

  ## Usage

  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](https://drive.google.com/file/d/1Y-Vkb7LIPCX1cr5C0Y6N80GtxbAAZbfq/view?usp=drive_link)

  ## License

  ![License Badge](https://img.shields.io/badge/License-ISC-blue.svg)


  [License Guide](https://opensource.org/licenses/ISC)


  This project is licensed under the ISC License - see the [LICENSE.md](LICENSE.md) file for details.

  ## Contributing

  Please enter a new issue in the GitHub repo. Thanks!

  ## Tests

  This project does not have any tests yet.

  ## Questions

  [GitHub Profile](https://github.com/andrewhamerly)


  If you have additional questions, please email me at [email protected].

  ## Credits

  None