GithubHelp home page GithubHelp logo

professional-readme-generator's Introduction

Professional README Generator by HLRY

How to create a Professional README

License: Apache 2.0

Table of Contents

Description

This project will help you generate a professional README file in markdown format using node and your Command Line Interface.

Demonstration

Demo video: Professional

Sample

demo-readme-screen

Features

Utilizes javascript, node, npm (including Inquire), and markdown formats to bring you the README of your dreams.

Installation

Clone this project from GitHub to your local machine.

To install dependencies, run the following in your Command Line Interface (e.g., Terminal or Bash):

  • npm init
  • npm install manager

Usage

Then run the following command:

  • node index

LICENSE

This repository is licensed under the 'Apache License 2.0'. Refer to https://opensource.org/licenses/Apache-2.0 for complete license terms.

CONTRIBUTING

This project is not accepting contributions but if you send a pull request, it could be accepted under the terms of the Apache 2.0 license.

Credits

Significant collaborators to this project are (or will be) listed here: hamburgler

Questions

If you have questions contact me on GitHub at hlry.

professional-readme-generator's People

Contributors

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