Giter Club home page Giter Club logo

professional_readme_generator's Introduction

Professional README Generator

GITHUB Repository

https://github.com/Nolsar/Professional_README_Generator

Description

When creating an open source project on GitHub, it is important to have a quality README with information about the application, including 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. Using 100% JSON and Node Package Manager using the package Inquirer, a command-line application will allow for quick and easy generation of a project README to get started quickly. Once the user has inputed their responser, it will write the the README file. This will allow a project creator to spend more time working on finishing the project and less time creating a good README.

Usage

Brief demonstration on how to use the application. Click for demonstration.

A command-line application that dynamically generates a professional README.md from a user's input using the Inquirer package.

The application will be invoked with the following command in the intergated terminal: node index.

Contributing

Contributions are accepted. Feel free to fork.

Tests

Answer all questions and check the returned inputs.

Screenshots of working Generator

License

MIT License Copyright (c) 2021 Sara N.

professional_readme_generator's People

Contributors

nolsar avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.