ph-7 / github-readme-generator-cli

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

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 ✨

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.

github-readme-generator-cli's Issues

Add .gitattributes file, to exclude dev files in distribution archive file

https://www.pixelite.co.nz/article/using-git-attributes-exclude-files-your-release/

Prefill values from composer.json information

Pre-fill the name, description, author name, PHP requirement version from what can be found in composer.json file.

Use CommandTester for testing it

As mocking is difficult in my case since I don't inject SymfonyStyle, I should probably use CommandTester
https://symfony.com/doc/current/components/console/helpers/questionhelper.html#testing-a-command-that-expects-input

Use SymfonyStyle, Console Style Guide

https://symfony.com/blog/new-in-symfony-2-8-console-style-guide