Skip to content

JordanRL/Roster

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
bin
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Roster

Installation

To install, simply require the package using composer:

composer --dev require "samsara/roster:^0.1"

Or include it in your composer.json file:

{
    "require-dev": {
        "samsara/roster": "^0.1"
    }
}

The project namespace is Samsara\Roster\*. You can view the project on Packagist.

Examples of Documentation Built With Roster

  • Roster: This console program! Of course Roster builds its own documentation. :)
  • Fermat: An arbitrary precision math library with trigonometry, statistics and more for PHP.

Documentation

After installing, from your project root on the command-line use:

php vendor/bin/roster [SOURCES_ROOT]

You can read the full documentation for Roster here.

About

A PHP tool to generate templateable markdown documentation from the docblocks or type-hints of your codebase.

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published