Add "bin" info in composer

BafS · Aug 31, 2023 · 0359bb7 · 0359bb7
1 parent f74d5c8
commit 0359bb7
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@
 ## Run in the terminal
 
 - `composer i`
-- `./bin/app.php <yourgame.ch8>`
+- `./bin/chip8 <yourgame.ch8>`
 
 The default keyboard layout was mapped as follows:
 ```
@@ -25,6 +25,16 @@ A|0|B|F  ->  Z|X|C|V
 
 - `./vendor/bin/phpunit tests/ --testdox`
 
+## Quality
+
+### Static Analysis
+
+- `./vendor/bin/phpstan analyse src/ -l 7`
+
+### Syntax lint
+
+- `./vendor/bin/phpcs --standard=PSR12 src/`
+
 #### Documentation
 
 - https://chip-8.github.io/

diff --git a/bin/app.php → bin/chip8 b/bin/app.php → bin/chip8
@@ -1,7 +1,10 @@
+#!/usr/bin/env php
 <?php
 
 declare(strict_types=1);
 
+namespace BafS\Chip8\Bin;
+
 require './vendor/autoload.php';
 
 use BafS\Chip8\CPU;
@@ -110,8 +113,8 @@ private function execute(InputInterface $input, OutputInterface $output): int
     public function run(): int
     {
         return (new SingleCommandApplication())
-            ->addArgument('file', InputArgument::OPTIONAL, 'The rom')
-            ->addOption('frequency', 'f', InputOption::VALUE_REQUIRED)
+            ->addArgument('file', InputArgument::REQUIRED, 'The rom file')
+            ->addOption('frequency', 'f', InputOption::VALUE_REQUIRED, 'Run the emulation with the given frequency')
             ->setCode($this->execute(...))
             ->run();
     }

diff --git a/composer.json b/composer.json
@@ -6,6 +6,9 @@
             "email": "fabacrans@gmail.com"
         }
     ],
+    "bin": [
+        "bin/chip8"
+    ],
     "require": {
         "php": ">=8.1",
         "symfony/console": "^6.0"