Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/deponte-designer/readme-generator
README.md file generator on the command line using inquirer.
https://github.com/deponte-designer/readme-generator
generator inquirer javascript js markdown md nodejs npm-package readme readme-generator
Last synced: 3 days ago
JSON representation
README.md file generator on the command line using inquirer.
- Host: GitHub
- URL: https://github.com/deponte-designer/readme-generator
- Owner: deponte-designer
- License: mit
- Created: 2024-01-12T19:00:59.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-01-19T09:35:15.000Z (8 months ago)
- Last Synced: 2024-09-24T21:13:38.156Z (4 days ago)
- Topics: generator, inquirer, javascript, js, markdown, md, nodejs, npm-package, readme, readme-generator
- Language: JavaScript
- Homepage:
- Size: 34.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Professional README Generator
## Description
This project is a professional README generator designed to streamline the process of creating comprehensive README files for your GitHub projects. It uses JavaScript ES6 syntax and Node.js with Inquirer module to automate the generation of README files with detailed information about your project.
## Table of Contents
- [User Story](#user-story)
- [Installation](#installation)
- [Screenshots](#screenshots)
- [Video](#video)
- [Usage](#usage)
- [Credits](#credits)
- [Deployment](#deployment)
- [How to Contribute](#how-to-contribute)
- [Contributions](#contributions)
- [Starred Project](#starred-project)
- [Tests](#tests)
- [Questions](#questions)
- [License](#license)
- [Badges](#badges)
## User Story
**As A** developer,
**I WANT** a tool that can quickly generate a well-structured README for my GitHub projects,
**SO THAT** this tool allow me to input project details and preferences, and it should generate a README file that includes important sections like installation, usage, contribution guidelines, and licensing information.
## Installation
Users can install the project by cloning the repository from GitHub and running `npm install` to install the required dependencies.
## Screenshots
*Unfortunately, screenshots are not included in this project.*
## Video
A walkthrough video that demonstrates the functionality of the README generator: [Demo](https://drive.google.com/file/d/1HzDzS-Vo9k6ExBXWw-6eU2q1EfwJzyvO/view "Demonstration video")
## Usage
To use the README generator, run the command `node index.js` in the terminal. Follow the prompts to provide information about your project, and the generator will create a README file based on your input.
**Enhancing Terminal Commands for Efficient Workflow:**
1. Install dependencies:
```bash
npm install
```
2. Run the application:
```bash
node index.js
```
3. Stop the application:
```bash
^C
```
4. Clear the terminal:
```bash
clear
```
## Credits
* [Professional README Guide](https://coding-boot-camp.github.io/full-stack/github/professional-readme-guide)
* [Licensing a repository](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)
## Deployment
> This project is deployed and accessible at the following URLs:
>
> - [GitHub Repository](https://github.com/deponte-designer/Readme-Generator "Readme-Generator GitHub Repository"): Visit the repository for project details, including a comprehensive README.
> - [Demo video](https://drive.google.com/file/d/1HzDzS-Vo9k6ExBXWw-6eU2q1EfwJzyvO/view "Demonstration video"): Visit this link to watch the walkthrough video that demonstrates the functionality of the README generator.
>
## How to Contribute
To contribute to this project, follow these steps:
1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and submit a pull request.
### Contributions
This project was developed by a single contributor [dePonte](https://github.com/deponte-designer).
### Starred Project
⭐ Your support by clicking on the star icon located at the top right of the project page and adding it to your favourites list would be greatly appreciated!
## Tests
Unfortunately, the command `npm test` is currently not available for this project.
## Questions
> For any questions or concerns about the project, you can reach me at [GitHub: dePonte](https://github.com/deponte-designer).
## License
[](https://opensource.org/licenses/MIT)
Copyright © 2024 [dePonte](https://github.com/deponte-designer)
## Badges
