Merge pull request #190 from jodh-intel/doc-reqs-images

docs: Document image requirements
This commit is contained in:
Eric Ernst 2018-07-23 14:55:49 -07:00 committed by GitHub
commit 473c450c5e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -2,6 +2,7 @@
* [General requirements](#general-requirements) * [General requirements](#general-requirements)
* [Notes](#notes) * [Notes](#notes)
* [Code blocks](#code-blocks) * [Code blocks](#code-blocks)
* [Images](#images)
# Introduction # Introduction
@ -79,3 +80,21 @@ utility.
``` ```
``` ```
# Images
All binary image files must be in a standard and well-supported format such as
PNG. This format is preferred for vector graphics such as diagrams because the
information is stored more efficiently, leading to smaller file sizes. JPEG
images are acceptable, but this format is more appropriate to store
photographic images.
When possible, generate images using freely available software.
Every binary image file **MUST** be accompanied by the "source" file used to
generate it. This guarantees that the image can be modified by updating the
source file and re-generating the binary format image file.
Ideally, the format of all image source files is an open standard, non-binary
one such as SVG. Text formats are highly preferable because you can manipulate
and compare them with standard tools (e.g. `diff(1)`).