https://github.com/ph-7/github-readme-generator-cli

📄 A PHP README File Generator, to generate easily beautiful (and SEO-friendly) GitHub README files on the fly 🎉
https://github.com/ph-7/github-readme-generator-cli

generator github-readme github-readme-generator md-template readme readme-generator readme-markdown-generator readme-md-generator readme-template

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/ph-7/github-readme-generator-cli
• Owner: pH-7
• License: mit
• Created: 2021-10-23T12:24:36.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-11-27T06:44:52.000Z (about 2 years ago)
• Last Synced: 2024-05-02T06:14:30.556Z (9 months ago)
• Topics: generator, github-readme, github-readme-generator, md-template, readme, readme-generator, readme-markdown-generator, readme-md-generator, readme-template
• Language: PHP
• Homepage: https://github.com/pH-7/github-readme-generator-cli
• Size: 217 KB
• Stars: 10
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# 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](https://github.com/pH-7/github-readme-generator-cli/releases/tag/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 ✨

1. [Requirement](#-requirement)

2. [Setup](#%EF%B8%8F-setup)

3. [Me Coding It](#tv-video)

4. [About Me](#-about-me)

5. [License](#%EF%B8%8F-license)

## 📙 Requirement

* Make sure you have [PHP 8.0](https://www.php.net/releases/8_0_0.php) or a higher version installed.

## ⚙️ Setup

* Install Composer v2 or higher (https://getcomposer.org)

* Install the dependencies with composer as below

    ```bash

    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 😺

    ```bash

    ./generate

    ```

![GitHub README File Generator CLI](php-readme-generator-cli-sample.png)

## :tv: Video

[![Watch the video](https://i1.ytimg.com/vi/DsJRGl3y0KI/sddefault.jpg)](https://www.youtube.com/watch?v=DsJRGl3y0KI)

👉 **[Click here to watch on YouTube](https://www.youtube.com/watch?v=DsJRGl3y0KI)**

## 🤠 About Me

[![Pierre-Henry Soria](https://s.gravatar.com/avatar/a210fe61253c43c869d71eaed0e90149?s=200)](https://ph7.me "Pierre-Henry Soria personal website")

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

**[Pierre-Henry Soria](https://ph7.me)**, a highly passionate, zen & pragmatic software engineer 😊

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

## ⚖️ License

This **PHP README Generator CLI script** is generously distributed under the *[MIT](https://opensource.org/licenses/MIT)*.

[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