From 54b0a7d3a98309f84410711c47f28f0a64b90eb6 Mon Sep 17 00:00:00 2001 From: devlinjd Date: Sat, 10 Oct 2015 17:45:29 -0400 Subject: [PATCH] Update README. --- README.md | 27 ++++++++++++++++++++++++--- themes/README.md | 12 ------------ 2 files changed, 24 insertions(+), 15 deletions(-) delete mode 100644 themes/README.md diff --git a/README.md b/README.md index 2af1103..b422593 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,32 @@ watermark ========= -Dress up your resume for Halloween. Resume/CV themes for [FluentCV][1] and [FluentCMD][2] live here. +Predefined template-based resume themes for [FluentCV][1] and [FluentCMD][2]. + +- `minimist`: A no-frills theme. +- `informatic`: An informative theme for technical resumes. +- `modern`: A middle of the road theme with a modern look 'n feel. +- `hello-world`: A simple-as-possible example theme. +- New themes added weekly. + +## How It Works + +Each theme lives in a folder, e.g., `themes/informatic` or `themes/modern`. The folder contains individual template files assembled by the theme author. Each template can be used to generate a single type of output file such as HTML, Word, or PDF. Template files are named according to this scheme... + + [ OuputFormat ].[ InputFormat ] + +...where `[OuputFormat]` and `[InputFormat]` are both one of `html`, `pdf`, `md`, `txt`, `doc`, or `xml`. For example: + +- `html.html` = An HTML template used to generate an HTML document. +- `doc.xml` = An XML template used to generate an MS Word document. +- `pdf.html` = An HTML template used to generate a PDF document. +- `md.txt` = A text template used to generate a Markdown document. + +This scheme ensures that theme template files have the "correct" file extension when the theme author is working with them in an editor—if your source data is XML then the template file will have an `.xml` extension regardless of whether you're ultimately generating an HTML page or a PDF document *from* that XML. It also provides a declarative mapping between a given input format (say, XML) and a given output file type (say, a Word doc or spreadsheet). ## License -MIT. See [LICENSE.md][3] for details. +MIT. See [LICENSE.md][1] for details. [1]: http://fluentcv.com [2]: https://github.com/fluentdesk/fluentcmd -[3]: LICENSE.md +[3]: ../LICENSE.md diff --git a/themes/README.md b/themes/README.md deleted file mode 100644 index 05a8212..0000000 --- a/themes/README.md +++ /dev/null @@ -1,12 +0,0 @@ -themes -====== -Predefined template-based resume themes for FluentCV. - -- `minimist`: A no-frills theme. -- `informatic`: An informative theme for technical resumes. - -## License - -MIT. See [LICENSE.md][1] for details. - -[1]: ../LICENSE.md