Skip to content

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

License

Notifications You must be signed in to change notification settings

JordanRL/Roster

Folders and files

NameName
Last commit message
Last commit date

Latest commit

36f8ebb · Sep 8, 2021

History

44 Commits
Jul 5, 2021
Jul 8, 2021
Jul 8, 2021
Jul 16, 2021
Sep 8, 2021
Jul 8, 2021
Jul 2, 2021
Jul 16, 2021
Jul 8, 2021
Jul 8, 2021
Jul 17, 2021
Jul 8, 2021

Repository files navigation

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

Packages

No packages published