Readme and documentation updates and improvements

- Streamlined the intro text more
- Credited shello for his amazing work on introducing a caching system
- Added cache to the documentation

README.md

@@ -1,9 +1,5 @@
 ![Orxporter logo with 'orxporter' next to it, in white against a lime green background.](orxporter_logo.png)
 
-Emoji exporter used for Mutant Standard emoji set
-
-# Introduction
-
 orxporter is a rich toolkit for organising and exporting an SVG-based emoji set.
 It has a system for storing emoji metadata and making large batch export operations
 with that metadata, including multi-format and multi-resolution batch rendering,
@@ -29,16 +25,17 @@ Mutant Standard's [code of conduct](docs/code_of_conduct.md).
 
 # Features
 
-- Declarative language for defining semantics of emoji set
-- Color mapping (recoloring)
+- A custom declarative language for defining your emoji semantics and metadata
+- Color remapping
 - Outputting emoji both as shortcode-named files (ie. 'ice_cream') and unicode codepoint-named files (ie. '1f368')
 - Export to SVG, PNG, Lossless WebP, Lossless AVIF and FLIF
 - Optional lossless crushing of SVG and PNG files
 - Supports multiple SVG renderers (rendersvg, Inkscape and ImageMagick)
-- Output options including emoji filtering, customisable export directory
-  structure and filenaming
+- Output options including emoji filtering, export directory
+  structure and filenames
 - JSON output of emoji set metadata
 - SVG and EXIF licensing metadata embedding
+- Optional caching to save time on re-exporting
 - Multithreading
 
 
@@ -76,7 +73,8 @@ A longer guide with simpler language for those who are less techincally inclined
 
 # Contributors
 
-* AndrewMontagne - imagemagick support
+* @AndrewMontagne - imagemagick support
+* @shello - caching
 
 # License
 

docs/dzuk/howto.md

@@ -1,42 +1,50 @@
 
-# Input (`-i`)`
+### Input (`-i`)`
 
 The folder where the source images are located.
 
-# Output (`-o`)
+### Output (`-o`)
 
 Where forc outputs to.
 
-# Manifest (`-m`)
+### Manifest (`-m`)
 
 A file where you set all of your emoji metadata.
 
 Documentation on manifests coming soon.
 
 
-# Filter (`-e`) (optional)
+### Filter (`-e`) (optional)
 
 Set a conditions for what emoji in your input will actually get exported. Useful if you just want to export a slice of what you've got in your input and manifest.
 
 
-# Output parameters
+
+### Cache (`-C`) (optional)
+
+Set a directory as a cache. When a cache is set, orxporter will store a keyed copy of all of your exported emoji there, so when you export again, orxporter will only export the images that have changed or are in formats that it hasn't exported before, saving you time.
+
+(Make sure you point to the same cache directory when re-exporting with a different command or script!)
+
+
+### Output parameters
 
 forc can export your stuff into two things: **images** and **data**. The parameters you use will differ.
 
 ----
 
-## Image output
+#### Image output
 
 There are two different methods to export images in orxporter:
 
-### [Simple method](image_easy.md)
+##### [Simple method](image_easy.md)
 
 For beginners and light users.
 
 This method purely uses the command line to create exports.
 
 
-### [Slightly more advanced method](image_advanced.md)
+##### [Slightly more advanced method](image_advanced.md)
 
 For those who need to make heavy use of orxporter.
 
@@ -45,9 +53,9 @@ This method uses a .orx file to outline export types, enabling you to ask orxpor
 
 -----
 
-## Data output
+#### Data output
 
-### JSON export (`-j`, `-J`) (optional)
+##### JSON export (`-j`, `-J`) (optional)
 
 Compile the metadata you've set in .orx files into a JSON file for web and other applications.
 
@@ -60,20 +68,20 @@ Using this means that you're just exporting JSON for this command, you can't use
 
 ----
 
-# [Metadata](metadata.md)
+### [Metadata](metadata.md)
 
 forc can embed SVG or EXIF metadata into your exported emoji sets.
 
 ---
 
-# Extra flags
+### Extra flags
 
-## Force Text Descriptions (`--force-desc`)
+#### Force Text Descriptions (`--force-desc`)
 
 Makes orxporter complain if there are any emoji with missing text descriptions.
 
 
-## Check SVG image size (`-q`) (optional)
+#### Check SVG image size (`-q`) (optional)
 
 Check the size of your SVG's `viewBox` attribute to make sure there are no accidents in export.
 

docs/kiilas/usage.md

@@ -14,6 +14,7 @@ Here are the command line options:
   files are meant to be self-contained, this is relative to the manifest
   filepath (default: **in**)
 - **-o PATH** -- specifies output directory path; this is relative to the
+- **-C PATH** -- (optional) specifies a cache path to save time on repeat exports
   current directory (default: **out**)
 - **-f PATH_EXPR** -- specifies output filenaming for emoji; the following
   formatting codes are supported: **%c** for colormap, **%d** for source