Add 'Home'

John Bintz 2023-07-22 21:51:22 +00:00
parent 74c24b72b5
commit e82c2200b1

19
Home.md Normal file

@ -0,0 +1,19 @@
minicomic-backend uses a YAML file to define the project. The file is divided into sections: the Global section and one or more build target sections. Input files can either be found by using shell globbing and regular expressions, or by feeding a list of input files via the Global.files array. Each file, when being processed, has a set of properties applied to it in this order:
Global properties - Build targer properties - Individal file properties (if using the Global.files array)
h2. Properties
# print: true if the output is for print
# is_paginated: true if the output is to be paginated
# width, height: size of the output file in pixels
# page_width_inches, page_height_inches: the width & height of the output page
# dpi: the DPI of the page output (not the file output)
# width_inches, height_inches: the size of the output file in inches
# rotate: rotate the sized output image 90, 180, or -90 degrees before placing it on the page/outputting the web-ready file
# grid: the columns x rows in which to split the output page when multiple comics are fed to i
# target: the output filename. for print use .pdf as the extension. for web, use the target output format (jpg, gif, png)
h2. Global
The Global