PHP Classes

PHP GitHub Readme Generator: Generate Markdown files to describe projects

Recommend this page to a friend!
  Info   View files Example   Screenshots Screenshots   View files View files (19)   DownloadInstall with Composer Download .zip   Reputation   Support forum   Blog (1)    
Last Updated Ratings Unique User Downloads Download Rankings
2022-08-17 (3 months ago) RSS 2.0 feedNot yet rated by the usersTotal: 62 This week: 1All time: 10,181 This week: 491Up
Version License PHP version Categories
github-readme-genera 1.0GNU General Publi...5PHP 5, Utilities and Tools, Files and..., C..., P...
Description Author

This package can generate Markdown files to describe projects.

It implements an application that runs from the command line interface console to generate a Markdown document README file that describes a project using answers provided by the project author.

Currently, it asks questions to the project author about:

- Name

- Summary

- Description

- Requirements

- Author name, email, Web page, GitHub user

- License

- Etc.

Innovation Award
PHP Programming Innovation award winner
August 2022
Winner
GitHub is a popular site among developers. It provides free git repository hosting to help developers keep track of their project revisions and publish their projects on the Web to increase project exposure.

GitHub also shows README files to allow developers to describe their project details using the Markdown format in a single text document.

This package helps generate README files in Markdown format that is suitable to display in sites like GitHub and the PHP Classes repository just by asking a few questions to the project authors.

Manuel Lemos
Picture of Pierre-Henry Soria
  Performance   Level  
Name: Pierre-Henry Soria <contact>
Classes: 39 packages by
Country: United Kingdom
Age: 31
All time rank: 41219 in United Kingdom
Week rank: 4 Up1 in United Kingdom Up
Innovation award
Innovation award
Nominee: 15x

Winner: 2x

Details

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 &amp; 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/ -->

Screenshots  
  • php-readme-generator-cli-sample.png
  Files folder image Files  
File Role Description
Files folder image.github (1 directory)
Files folder imagebin (1 file)
Files folder imagesrc (1 file, 1 directory)
Files folder imagetests (1 file, 1 directory)
Accessible without login Plain text file composer.json Data Auxiliary data
Accessible without login Plain text file generate Data Auxiliary data
Accessible without login Plain text file LICENSE.md Lic. License text
Accessible without login Plain text file phpunit.xml.dist Data Auxiliary data
Accessible without login Plain text file README.md Doc. Documentation
Accessible without login Plain text file save-code.sh Data Auxiliary data

  Files folder image Files  /  .github  
File Role Description
Files folder imageworkflows (1 file)

  Files folder image Files  /  .github  /  workflows  
File Role Description
  Accessible without login Plain text file test.yml Data Auxiliary data

  Files folder image Files  /  bin  
File Role Description
  Accessible without login Plain text file generate Example Example script

  Files folder image Files  /  src  
File Role Description
Files folder imageCommand (2 directories)
  Plain text file DefaultValue.php Class Class source

  Files folder image Files  /  src  /  Command  
File Role Description
Files folder imageException (2 files)
Files folder imageMarkdown (3 files, 1 directory)

  Files folder image Files  /  src  /  Command  /  Exception  
File Role Description
  Plain text file EmptyFieldException.php Class Class source
  Plain text file InvalidInputException.php Class Class source

  Files folder image Files  /  src  /  Command  /  Markdown  
File Role Description
Files folder imageview (1 file)
  Plain text file Builder.php Class Class source
  Plain text file GeneratorCommand.php Class Class source
  Plain text file License.php Class Class source

  Files folder image Files  /  src  /  Command  /  Markdown  /  view  
File Role Description
  Accessible without login Plain text file readme-template.md Doc. Documentation

  Files folder image Files  /  tests  
File Role Description
Files folder imageCommand (1 directory)
  Accessible without login Plain text file bootstrap.php Aux. Auxiliary script

  Files folder image Files  /  tests  /  Command  
File Role Description
Files folder imageMarkdown (3 files)

  Files folder image Files  /  tests  /  Command  /  Markdown  
File Role Description
  Plain text file BuilderTest.php Class Class source
  Plain text file GeneratorCommandTest.php Class Class source
  Plain text file LicenseTest.php Class Class source

 Version Control Unique User Downloads Download Rankings  
 100%
Total:62
This week:1
All time:10,181
This week:491Up