PHP Classes

File: README.md

Recommend this page to a friend!
  Classes of Pierre-Henry Soria   PHP GitHub Readme Generator   README.md   Download  
File: README.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: PHP GitHub Readme Generator
Generate Markdown files to describe projects
Author: By
Last change:
Date: 7 months ago
Size: 2,284 bytes
 

Contents

Class file image Download

README Generator ?

Simplest way to generate SEO-optimized GitHub README

? PHP README File Generator, to generate easily beautiful (and SEO-friendly) GitHub README files on the fly ?

  • NEW v1.2.0: Default values are pre-selected from the information already present in the `composer.json` file. > `github-readme-generator` reads `composer.json` info and suggest the default values during the creation of your `README.md` file ?

? Requirement

  • Make sure you have PHP 8.0 or a higher version installed.

?? Steup

  • Install Composer v2 or higher (https://getcomposer.org)
  • Install the dependencies with composer as below

    composer install
    
  • Update the permissions of the `generate` bash file located in the root directory

    chmod u+x ./generate
    
  • Run the script, and follow the instruction shown. Enjoy ?

    ./generate
    

GitHub README File Generator CLI

? About Me

Pierre-Henry Soria

[![@phenrysay][twitter-image]](https://twitter.com/phenrysay) [![pH-7][github-image]](https://github.com/pH-7)

Pierre-Henry Soria, a highly passionate, zen & pragmatic software engineer ?

You can keep in touch with me at: hi [AT] pH7 {D0T} me ?

:tv: Video

Watch the video

? Click here to watch on YouTube

?? License

This PHP README Generator CLI script is generously distributed under the MIT.

<!-- GitHub's Markdown reference links --> [twitter-image]: https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white [github-image]: https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white

<!-- Was generated by https://github.com/pH-7/github-readme-generator-cli/ -->