https://github.com/jordanrl/roster
A PHP tool to generate templateable markdown documentation from the docblocks or type-hints of your codebase.
https://github.com/jordanrl/roster
Last synced: 12 months ago
JSON representation
A PHP tool to generate templateable markdown documentation from the docblocks or type-hints of your codebase.
- Host: GitHub
- URL: https://github.com/jordanrl/roster
- Owner: JordanRL
- License: gpl-3.0
- Created: 2021-07-02T05:19:49.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-09-08T21:47:18.000Z (almost 5 years ago)
- Last Synced: 2025-07-05T05:17:09.995Z (about 1 year ago)
- Language: PHP
- Size: 7.06 MB
- Stars: 17
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 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:
```json
{
"require-dev": {
"samsara/roster": "^0.1"
}
}
```
The project namespace is `Samsara\Roster\*`. You can view the project on [Packagist](https://packagist.org/packages/samsara/roster).
## Examples of Documentation Built With Roster
- [Roster](https://jordanrl.github.io/Roster/): This console program! Of *course* Roster builds its own documentation. :)
- [Fermat](https://jordanrl.github.io/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](https://jordanrl.github.io/Roster/).