项目作者: cynmojica1231

项目描述 :
Good README Generator
高级语言: JavaScript
项目地址: git://github.com/cynmojica1231/Homework8.git
创建时间: 2020-10-06T02:07:01Z
项目社区:https://github.com/cynmojica1231/Homework8

开源协议:MIT License

下载


Good ReadMe Generator

GitHub license

Description

When creating an open source project on GitHub, it is important to have a quality README with information about the app—what is the app for, how to use the app, how to install it, how to report issues, and how to make contributions so that other developers are more likely to use and contribute to the success of the project. A command-line application will allow for quick and easy generation of a project README to get started quickly. This will allow a project creator to spend more time working on finishing the project and less time creating a good README.

Table of Contents

Installation

To install necessary dependencies, run the following command:

  1. npm i

Usage

Instructions and examples for use:

Gif demo of README-generator

License

This project is licensed under the MIT license.

Contributing

you can add a file with contribution guidelines to your project repository’s root, docs, or .github folder. When someone opens a pull request or creates an issue, they will see a link to that file.

Tests

To run tests, run the following command:

  1. npm test

Questions

If you have any questions about the repo, open an issue or contact me directly at cynmojica12131@gmail.com. You can find more of my work at cynmojica1231.