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

This application serves the purpose of assisting developers to quickly create a professional README.
https://github.com/rfabreu/readme-generator

Last synced: about 1 month ago
JSON representation

This application serves the purpose of assisting developers to quickly create a professional README.

• Host: GitHub
• URL: https://github.com/rfabreu/readme-generator
• Owner: rfabreu
• Created: 2022-07-06T21:00:40.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-07-09T20:21:25.000Z (almost 3 years ago)
• Last Synced: 2025-01-25T05:09:00.484Z (3 months ago)
• Language: JavaScript
• Size: 354 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# README Generator

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

## Description

This application assists developers to quickly generate professional README files. 


As an example this `README` was created using this application.

## Table of Contents

- [Description](#description)

- [Installation](#installation)

- [Usage](#usage)

- [License](#license)

- [Contributing](#contributing)

- [Tests](#tests)

- [Questions](#questions)

## Installation

Clone the application repository to your local path. `cd` into `develop` and run `npm i` or `npm install`.

## Usage

In your terminal ensure you are in the `develop` directory and run `node index.js` or `node index` to to run the application. Fill all the prompts, then `cd` into the `dist` directory to find your `README.md` file.


 


### Application Run Process:

![Application running process](./Develop/assets/images/app_run.png)

### Demo Video

Watch a demo of the application running: [App Demo](https://drive.google.com/file/d/1p-_po8fnrgY4lg3X1aOg0Pd4jjgSN-Yc/view)




## License

Licensed under the MIT license.

## Contributing

If you wish to contribute to the project you may submit PRs as needed.

## Tests

There are no test cases implemented currently. If you wish to test the application you may follow the `installation` and `running` instructions.

## Questions

GitHub: [github.com/rfabreu](https://github.com/rfabreu)




Comments, suggestions, questions? Contact me at: [[email protected]](mailto:[email protected])