ph-7/php-readme-generator-file

A simple way to generate a GitHub README file

v1.2.4 2022-02-21 09:14 UTC

Requires

• php: >=8.0.0
• monolog/monolog: ^2.3
• nadar/php-composer-reader: ^1.3
• ph-7/ph2gravatar: ^1.1
• symfony/console: ^5.3

Requires (Dev)

• phake/phake: ^4.2
• phpunit/phpunit: ^9.5

MIT

• Pierre-Henry Soria

• cli
• md
• readme
• readme md generator
• md template
• md generator
• readme template
• github readme
• readme generator
• generate readme

README

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 ✨

1. Requirement
2. Setup
3. Me Coding It
4. About Me
5. License

📙 Requirement

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

⚙️ Setup

• 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

📺 Video

👉 Click here to watch on YouTube

🤠 About Me

Pierre-Henry Soria, 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.