Skip to content

An app to automatically generate professional README's for busy Developers!

License

Notifications You must be signed in to change notification settings

strawhat19/README-Generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

README Generator

License Badge: MIT

Generates README's

Video

Link To Video

Step 1: Navigate to the Terminal

Reveal

Step 2: Open your Preferred Terminal

Git Bash Here

Step 3: Answer the Questions

Using the App

Step 4: Once you Answer All Questions, README is Generated

Final Use

Step 5: Now you can view the Generated README File

Generated

Step 6: You can Preview it in VS Code

Preview

Step 7: Or push it to Github and View it there

Final Preview

Final: Finished Screen

ScreenShot

Table of Contents

Installation

Run the command NPM Install to Install!

Usage

Use Node.js CLI (Command Line Interface) to run this Application.

Tests

Jest & NPM Tests were used to ensure quality on this Application.

Contributors

The Contributors of this Application: Rakib Ahmed.

Contributions

To contribute to this application, you can: Fork it, Clone it, Branch it!

Licensing

License Badge: MIT

    MIT License

    Copyright (C) 2012-2020 by various contributors (see AUTHORS)

    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    THE SOFTWARE.
    
    Copyright 1998 by the Massachusetts Institute of Technology.

    Permission to use, copy, modify, and distribute this software and its
    documentation for any purpose and without fee is hereby granted, provided that
    the above copyright notice appear in all copies and that both that copyright
    notice and this permission notice appear in supporting documentation, and that
    the name of M.I.T. not be used in advertising or publicity pertaining to
    distribution of the software without specific, written prior permission.
    M.I.T. makes no representations about the suitability of this software for any
    purpose.  It is provided "as is" without express or implied warranty.

Questions

GitHub Profile: strawhat19

Contact me or ask me questions at rakib987@gmail.com.

About

An app to automatically generate professional README's for busy Developers!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published