filmroellchen/intro-outro-generator
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

beautified README

Browse source
This commit is contained in:
thomic 2016-09-09 16:15:48 +02:00
parent 4dcffdc19a
commit ab18874649
1 changed files with 31 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

47
README.md
View file

@ -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. 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 C3VOC Intro-Outro-Generator
positional arguments: positional arguments:
yourproject/ yourproject/
Path to your project is a required argument. Path to your project is a required argument.
Usage: ./make.py yourproject/ Usage: ./make.py yourproject/
Without any further argument(s) given, your whole project will be rendered. Without any further argument(s) given, your whole project will be rendered.
optional arguments: optional arguments:
-h, --help show this help message and exit
-h, --help
show this help message and exit
--debug --debug
Run script in debug mode and just render the debug values
given in your projects __init.py__ Run script in debug mode and just render the debug values
This argument must not be used together with --id given in your projects __init.py__
Usage: ./make.py yourproject/ --debug This argument must not be used together with --id
Usage: ./make.py yourproject/ --debug
--id ID [ID ...] --id ID [ID ...]
Only render the given ID(s) from your projects schedule.
This argument must not be used together with --debug Only render the given ID(s) from your projects schedule.
Usage: ./make.py yourproject/ --id 4711 0815 4223 1337 This argument must not be used together with --debug
To skip all IDs (just generate intro/outro/background files) use it with --id 000000 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 SKIP [SKIP ...]
Skip outro, pause and/or background files in rendering if not needed.
This argument must not be used together with --debug Skip outro, pause and/or background files in rendering if not needed.
Usage: ./make.py yourproject/ --skip pause out bg This argument must not be used together with --debug
Example - only generate outro: ./make.py yourproject/ --skip pause bg Usage: ./make.py yourproject/ --skip pause out bg
Example - only generate pause and background: ./make.py yourproject/ --skip out Example - only generate outro: ./make.py yourproject/ --skip pause bg
Example - only generate pause and background: ./make.py yourproject/ --skip out
```
The Frame-Generators The Frame-Generators
-------------------- --------------------