Commit f64f92e8dff51925e4aa6624aa55439358130d55

Authored by Georg Hopp
1 parent 272e295b

improve README.md

Showing 1 changed file with 48 additions and 14 deletions
1 -# GetCD  
2 -  
3 -## abstract 1 +# getcd
4 2
5 A small script to rip and encode audio from a CD. 3 A small script to rip and encode audio from a CD.
6 4
7 -## requires  
8 -  
9 - - bash  
10 - - flac  
11 - - cdrtools  
12 - - cdrdao  
13 - - lame  
14 -  
15 -## status  
16 -  
17 - unknown  
  5 +## Synopsis
  6 +
  7 + ./getcd.sh [-t(m|f|o|w)] [-p path] [-e encoder] [-c cddbitem] [-h]
  8 + [-I interface] [-D device] [-v[v|0]] [-q] [-s]
  9 + [--help] [--encoding=(m|f|o|w)] [--encoder=(lame|bladeenc)]
  10 + [--path=<string>] [--interface=(cooked_ioctl|generic_scsi)]
  11 + [--device=<string>]
  12 +
  13 +
  14 +## Description
  15 +
  16 +To be written....
  17 +
  18 +## Requirements
  19 +
  20 + * bash
  21 +
  22 +## Dependencies
  23 +
  24 + * flac
  25 + * cdrtools
  26 + * cdrdao
  27 + * lame
  28 +
  29 +## Contributing
  30 +
  31 +No contribution now, sorry.
  32 +
  33 +## License
  34 +
  35 +This program is free software: you can redistribute it and/or modify
  36 +it under the terms of the GNU General Public License as published by
  37 +the Free Software Foundation, either version 3 of the License, or
  38 +(at your option) any later version.
  39 +
  40 +This program is distributed in the hope that it will be useful,
  41 +but WITHOUT ANY WARRANTY; without even the implied warranty of
  42 +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  43 +GNU General Public License for more details.
  44 +
  45 +You should have received a copy of the GNU General Public License
  46 +along with this program. If not, see <http://www.gnu.org/licenses/>.
  47 +
  48 +## Author
  49 +
  50 +Georg Hopp <georg@steffers.org>
  51 +
Please register or login to post a comment