From ab188746493535952b298c34ba7a238372a4f397 Mon Sep 17 00:00:00 2001 From: thomic Date: Fri, 9 Sep 2016 16:15:48 +0200 Subject: [PATCH] beautified README --- README.md | 53 +++++++++++++++++++++++++++++++---------------------- 1 file changed, 31 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 2ec2725..d27a671 100644 --- a/README.md +++ b/README.md @@ -40,39 +40,48 @@ Quick start Start your own project by copying "00_example_render_byid" folder which contains all changes to use the new features. -Just type ./make.py or ./make.py -h in the main directory and you'll get the following help information. +Just type `./make.py` or `./make.py -h` in the main directory and you'll get the following help information. -usage: see help with option -h +```usage: see help with option -h C3VOC Intro-Outro-Generator positional arguments: - yourproject/ - Path to your project is a required argument. - Usage: ./make.py yourproject/ - Without any further argument(s) given, your whole project will be rendered. + + yourproject/ + Path to your project is a required argument. + Usage: ./make.py yourproject/ + Without any further argument(s) given, your whole project will be rendered. optional arguments: - -h, --help show this help message and exit - --debug - Run script in debug mode and just render the debug values - given in your projects __init.py__ - This argument must not be used together with --id - Usage: ./make.py yourproject/ --debug + + -h, --help + + show this help message and exit + + --debug + + Run script in debug mode and just render the debug values + given in your projects __init.py__ + This argument must not be used together with --id + Usage: ./make.py yourproject/ --debug - --id ID [ID ...] - Only render the given ID(s) from your projects schedule. - This argument must not be used together with --debug - Usage: ./make.py yourproject/ --id 4711 0815 4223 1337 - To skip all IDs (just generate intro/outro/background files) use it with --id 000000 + --id ID [ID ...] + + Only render the given ID(s) from your projects schedule. + This argument must not be used together with --debug + Usage: ./make.py yourproject/ --id 4711 0815 4223 1337 + To skip all IDs (just generate intro/outro/background files) use it with --id 000000 --skip SKIP [SKIP ...] - Skip outro, pause and/or background files in rendering if not needed. - This argument must not be used together with --debug - Usage: ./make.py yourproject/ --skip pause out bg - Example - only generate outro: ./make.py yourproject/ --skip pause bg - Example - only generate pause and background: ./make.py yourproject/ --skip out + + Skip outro, pause and/or background files in rendering if not needed. + This argument must not be used together with --debug + Usage: ./make.py yourproject/ --skip pause out bg + Example - only generate outro: ./make.py yourproject/ --skip pause bg + Example - only generate pause and background: ./make.py yourproject/ --skip out +``` The Frame-Generators --------------------