search

JordanRL / Roster

A PHP tool to generate templateable markdown documentation from the docblocks or type-hints of your codebase.
GNU General Public License v3.0
15 stars 0 forks source link

Bug found in: docs #9

Closed SDanDyS closed 3 years ago

SDanDyS commented 3 years ago

Describe the bug The documentation seems to be off. It has composer require-dev "samsara/roster:^0.1", but require-dev is not defined.

To Reproduce Steps to reproduce the behavior: Use composer with the following line: composer require-dev "samsara/roster:^0.1".

Expected behavior An error with the following message: [Symfony\Component\Console\Exception\CommandNotFoundException] Command "require-dev" is not defined.

PHP Version PHP 8.0

Additional context In the github documentation it says to use the following command for composer: composer require "samsara/roster:^0.1". In the docs in says to use the following command: composer require-dev "samsara/roster:^0.1" (which causes the error).

JordanRL commented 3 years ago

Oh hmm. I'll update this. The command should be this:

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