From f64f92e8dff51925e4aa6624aa55439358130d55 Mon Sep 17 00:00:00 2001 From: Georg Hopp Date: Sun, 20 Mar 2016 23:27:57 +0100 Subject: [PATCH] improve README.md --- README.md | 62 ++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 48 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 467af98..03c5dcc 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,51 @@ -# GetCD - -## abstract +# getcd A small script to rip and encode audio from a CD. -## requires - - - bash - - flac - - cdrtools - - cdrdao - - lame - -## status - - unknown \ No newline at end of file +## Synopsis + + ./getcd.sh [-t(m|f|o|w)] [-p path] [-e encoder] [-c cddbitem] [-h] + [-I interface] [-D device] [-v[v|0]] [-q] [-s] + [--help] [--encoding=(m|f|o|w)] [--encoder=(lame|bladeenc)] + [--path=] [--interface=(cooked_ioctl|generic_scsi)] + [--device=] + + +## Description + +To be written.... + +## Requirements + + * bash + +## Dependencies + + * flac + * cdrtools + * cdrdao + * lame + +## Contributing + +No contribution now, sorry. + +## License + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . + +## Author + +Georg Hopp +