Giter Club home page Giter Club logo

readme-generator's Introduction

ReadMe Generator

This ReadMe file was generated using this application

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

https://drive.google.com/file/d/1D9oKrIDHp70Z40eAqWdX71MTDMvIQ0aL/view?usp=sharing

ReadME.Generator.mp4

Description

Generate a professional ReadME.md with user prompted input. User runs command to install npm dependencies. User then runs node index.js in command line where user is prompted a series of questions about their project and how to reach them to generate a ReadMe file containing all applicable sections. Sections can be navigated by clicking the their respective names in the Table of Contents. User's GitHub username and email address can be clicked to be navigated to view other projects and send email with additional questions.

Table of Contents

Installation

To install necessary dependencies, run command:

npm i

Usage

Instructions for use ReadMe Generator:

Run command node index.js

Contributing

Guidelines to contribute to this project:

GitHub clone repository, create sandbox branch, submit pull request for review.

Tests

No tests are available at this time.

Questions

For any additional questions, you may reach me at [email protected].

To view my other work, please visit my GitHub profile at ConnieMarie.

Screenshot of index.js

screenshot1

Screenshot of generateMarkdown.js

screenshot2

Screenshot of ReadME generated with application

screenshot3

Screenshot of ReadME Preview generated with application

screenshot4

readme-generator's People

Contributors

conniemarie 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.