Giter Club home page Giter Club logo

read-me-generator's Introduction

Read-Me-Generator

Screen Shot 2021-05-15 at 10 40 01 PM

Purpose

This project generates read-me.md files using CLI. User answers questions about their project and based on user input a polished read-me file is generated and saved. This application is intended to increase user productivity and efficiency by creating formatting automatically.

Install

Clone this repository and run the application with the command line. node index.js will runn application.

Usage

Walkthrough Video 1: https://drive.google.com/file/d/1cKXK4rALYEYYtBPUJPz0JHOeCf7McCAI/view

Walkthrough Video 2: https://drive.google.com/file/d/17nsKbDseIWpI-xOxvheuKmJSxaZ923kL/view

User will be prompted to answer the following items:

  1. What is your project name
  2. Enter description
  3. Enter License
  4. Steps required for install
  5. Instructions and examples for use
  6. Collaborators
  7. Third party assets
  8. tutorials
  9. License description
  10. Screenshots
  11. Github user id
  12. Github link
  13. email address
  14. How can others contribute
  15. How to test project

After entries a markdown file will be created with a header, table of contents, installation, usage, credits, license, contributing, tests, and questions sections. The user can use this as many times as desired, however it is recommended that after each read-me is generated, the user save the file, because it will be over-written upon next use.

Built With

  • Javascript
  • node.js
  • npm inquirer
  • VS Stuidio

Website

Issues

-Will require further development to include specific placement of imagery.

Contribution

Made with ❤️ by Lindsey Krause with starter files from Trilogy

read-me-generator's People

Contributors

lindseykrause avatar

Watchers

 avatar

read-me-generator's Issues

MVP

AS A developer
I WANT a README generator
SO THAT I can quickly create a professional README for a new project

GIVEN a command-line application that accepts user input
WHEN I am prompted for information about my application repository

  • THEN a high-quality, professional README.md is generated with the title of my project and sections entitled Description, Table of Contents, Installation, Usage, License, Contributing, Tests, and Questions

WHEN I enter my project title

  • THEN this is displayed as the title of the README

WHEN I enter a description, installation instructions, usage information, contribution guidelines, and test instructions

  • THEN this information is added to the sections of the README entitled Description, Installation, Usage, Contributing, and Tests

WHEN I choose a license for my application from a list of options

  • THEN a badge for that license is added near the top of the README and a notice is added to the section of the README entitled License that explains which license the application is covered under

WHEN I enter my GitHub username

  • THEN this is added to the section of the README entitled Questions, with a link to my GitHub profile

WHEN I enter my email address

  • THEN this is added to the section of the README entitled Questions, with instructions on how to reach me with additional questions

WHEN I click on the links in the Table of Contents

  • THEN I am taken to the corresponding section of the README

Deliverables: 20%

A sample README generated using the application must be submitted.

Your GitHub repository containing your application code.

Walkthrough Video: 27%

  • A walkthrough video that demonstrates the functionality of the README generator must be submitted and a link to the video should be included in your README file.

  • The walkthrough video must demonstrate how a user would invoke the application from the command line.

  • The walkthrough video must demonstrate how a user would enter responses to all of the prompts in the application.

  • The walkthrough video must demonstrate a generated README that matches the user input and has a functioning table of contents.

Technical Acceptance Criteria: 40%

Satisfies all of the above acceptance criteria plus the following:

  • Uses the Inquirer package (Links to an external site.).

Repository Quality: 13%

  • Repository has a unique name.

  • Repository follows best practices for file structure and naming conventions.

  • Repository follows best practices for class/id naming conventions, indentation, quality comments, etc.

  • Repository contains multiple descriptive commit messages.

  • Repository contains a high-quality README with description and a link to walkthrough video.

generate markdown js part 1 license

  • create a function that returns a license badge based on which license is passed, if none, return an empty string
  • create function that returns license link if there is none, return an empty string
  • create function that returns the license section of readme if none return an empty string

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.