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)    
Ratings Unique User Downloads Download Rankings
Not yet rated by the usersTotal: 67 All time: 10,227 This week: 125Up
Version License PHP version Categories
github-readme-genera 1.0.0GNU General Publi...5PHP 5, Utilities and Tools, Files and..., C..., 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  
Name: Pierre-Henry Soria <contact>
Classes: 43 packages by
Country: United Kingdom
Age: 32
All time rank: 38916 in United Kingdom
Week rank: 1 Up

Level 1 Star

 Innovation award
Innovation award
Nominee: 16x

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();

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

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:67
This week:0
All time:10,227
This week:125Up

  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.