README -> README.md

2025-10-03 15:24:13 -06:00
parent 920d564205
commit a6bb68e561
2 changed files with 9 additions and 4 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,56 @@
+```
+CDPLAYER(1)                      User Commands                     CDPLAYER(1)
+
+NNAAMMEE
+       cdplayer - simple CD audio player using ALSA
+
+SSYYNNOOPPSSIISS
+       ccddppllaayyeerr _c_d_r_o_m [ccaarrdd==_N] [ddeevviiccee==_N]
+
+DDEESSCCRRIIPPTTIIOONN
+       ccddppllaayyeerr is a lightweight command-line program to play audio CDs using
+       the ALSA sound system.
+
+       It reads raw audio from a CD-ROM device (such as _/_d_e_v_/_s_r_0 ) and outputs
+       sound through the specified ALSA card and PCM device.
+
+       By default, ccddppllaayyeerr uses ALSA card 0 and PCM device 0.
+
+OOPPTTIIOONNSS
+       _c_d_r_o_m  CD-ROM device file, e.g.  _/_d_e_v_/_s_r_0
+
+       ccaarrdd==_N ALSA sound card number. Defaults to 0.
+
+       ddeevviiccee==_N
+              ALSA PCM device number. Defaults to 0.
+
+SSIIGGNNAALLSS
+       Playback can be controlled by sending signals to the ccddppllaayyeerr process:
+
+       SSIIGGUUSSRR11
+              Seek forward 1 minute.
+
+       SSIIGGUUSSRR22
+              Seek backward 1 minute.
+
+       SSIIGGSSTTOOPP
+              Pause playback.
+
+       SSIIGGCCOONNTT
+              Resume playback.
+
+EEXXAAMMPPLLEESS
+       Play a CD from the first drive on the default sound card:
+              cdplayer /dev/sr0
+
+       Play a CD using ALSA card 1, device 0:
+              cdplayer /dev/sr1 card=1 device=0
+
+LLIICCEENNSSEE
+       0BSD - Zero Clause BSD License.
+
+AAUUTTHHOORR
+       Written by Pedro E. D??az <ppedroediaz@gmail.com>
+
+cdplayer 1.0                     October 2025                      CDPLAYER(1)
+```