PHP Classes

PHP GitHub Readme Generator: Generate Markdown files to describe projects

Recommend this page to a friend!
     
  Info   Example   Screenshots   View files Files   Install with Composer Install with Composer   Download Download   Reputation   Support forum   Blog    
Ratings Unique User Downloads Download Rankings
Not yet rated by the usersTotal: 71 All time: 10,265 This week: 48Up
Version License PHP version Categories
github-readme-genera 1.0.0GNU General Publi...5PHP 5, Tools, Files and Folders, Console, P...
Description 

Author

Pierre-Henry Soria

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  

Level 1 Star

 Innovation award
Innovation award
Nominee: 18x

Winner: 3x

 

Example

#!/usr/bin/env php

<?php
/**
 * Copyright (c) Pierre-Henry Soria <hi@ph7.me>
 * MIT License - https://opensource.org/licenses/MIT
 */

define('ROOT_DIR', dirname(__DIR__, 1) . DIRECTORY_SEPARATOR);
define('APP_NAME', 'README File Generator');
define('APP_VERSION', '1.0.0');

require ROOT_DIR . '/vendor/autoload.php';

use Monolog\{Handler\StreamHandler, Logger};
use PH7\PhpReadmeGeneratorFile\Command\Markdown\{GeneratorCommand, Information};
use Symfony\Component\Console\Application;

$logger = new Logger('ReadmeGenerator');
$logger->pushHandler(new StreamHandler('php://stdout', Logger::DEBUG));

$app = new Application(
    APP_NAME,
    APP_VERSION
);

$commands = [
    new GeneratorCommand()
];

$app->addCommands($commands);

$app->run();

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 (1)  
  • php-readme-generator-cli-sample.png
  Files folder image Files (20)  
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

The PHP Classes site has supported package installation using the Composer tool since 2013, as you may verify by reading this instructions page.
Install with Composer Install with Composer
Downloadgithub-readme-genera-2022-08-17.zip 147KB
Downloadgithub-readme-genera-2022-08-17.tar.gz 143KB
Install with ComposerInstall with Composer
 Version Control Unique User Downloads Download Rankings  
 100%
Total:71
This week:0
All time:10,265
This week:48Up

  Applications that use this package  
No pages of applications that use this class were specified.

Add link image If you know an application of this package, send a message to the author to add a link here.