beautified README

This commit is contained in:
thomic 2016-09-09 16:15:48 +02:00
parent 4dcffdc19a
commit ab18874649

View file

@ -40,13 +40,14 @@ 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/
@ -54,25 +55,33 @@ positional arguments:
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 Run script in debug mode and just render the debug values
given in your projects __init.py__ given in your projects __init.py__
This argument must not be used together with --id This argument must not be used together with --id
Usage: ./make.py yourproject/ --debug Usage: ./make.py yourproject/ --debug
--id ID [ID ...] --id ID [ID ...]
Only render the given ID(s) from your projects schedule. Only render the given ID(s) from your projects schedule.
This argument must not be used together with --debug This argument must not be used together with --debug
Usage: ./make.py yourproject/ --id 4711 0815 4223 1337 Usage: ./make.py yourproject/ --id 4711 0815 4223 1337
To skip all IDs (just generate intro/outro/background files) use it with --id 000000 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. Skip outro, pause and/or background files in rendering if not needed.
This argument must not be used together with --debug This argument must not be used together with --debug
Usage: ./make.py yourproject/ --skip pause out bg Usage: ./make.py yourproject/ --skip pause out bg
Example - only generate outro: ./make.py yourproject/ --skip pause bg Example - only generate outro: ./make.py yourproject/ --skip pause bg
Example - only generate pause and background: ./make.py yourproject/ --skip out Example - only generate pause and background: ./make.py yourproject/ --skip out
```
The Frame-Generators The Frame-Generators
-------------------- --------------------