Git Product home page Git Product logo

09_professional_readme_generator's Introduction

Professional README Generator

MIT license

This is a command line program that prompts for input in order to generate a professional looking README file for most software projects.



Table of Contents



Installation

Node.js is required for this software to work. Clone the repository from GitHub. Then use 'npm install' on the command line to install the npm packages this project depends on.



Usage

Video Tutorial

From the root folder of the repository, open a command line interface and type the command 'node index.js' and then follow the prompts. When completed, a README file will appear in the Output directory.



License

MIT



Contributing

Please open an issue in the GitHub repository and we can discuss items of contribution. You can also reach me at the email address below.



Tests

Currently, this project has no testing scripts. Test at your own discretion.



Questions

If you have questions about the project you can email me, or you can open an issue in the GitHub repository.

My GitHub profile is benjDG

Email: [email protected]

09_professional_readme_generator's People

Contributors

benjdg avatar

Watchers

avatar

09_professional_readme_generator's Issues

Render license on README doc

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

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.