Merge pull request #10 from fluentdesk/v0.6.0

V0.6.0

LICENSE.md

@@ -1,7 +1,7 @@
 The MIT License
 ===============
 
-Copyright (c) 2015 James M. Devlin (https://github.com/devlinjd)
+Copyright (c) 2015 James M. Devlin (https://github.com/hacksalot)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,27 +1,44 @@
 fluent-themes
 =============
-Resume themes for [FluentCV][1] and [FluentCV command line][2].
+Stylized templates for your résumé and/or CV, compatible with [FRESH][f] and
+[JSON Resume][jrs] formats.
 
+- `awesome`: A technical resume theme based on Awesome-CV.
 - `minimist`: A no-frills theme.
 - `modern`: A middle of the road theme with a modern look 'n feel.
 - `hello-world`: A simple-as-possible example theme.
 - `compact`: A compact theme.
-- New themes forthcoming.
+- New themes weekly.
 
-## How It Works
+## Install
 
-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...
+You don't need to install this repository to use the themes; just install
+[FluentCV Desktop][1] or [Command Line][2]. Otherwise you can install the latest official standalone version of the theme repository over NPM...
 
-    [ OuputFormat ].[ InputFormat ]
+`[sudo] npm install fluent-themes --save`
 
-...where `[OuputFormat]` and `[InputFormat]` are both one of `html`, `pdf`, `md`, `txt`, `doc`, or `xml`. For example:
+...or fork and clone it as usual.
 
-- `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.
+## Structure
 
-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).
+FRESH themes are structured to allow for flexible generation of documents in
+multiple formats. Each theme lives in a separate folder and consists of:
+
+- A JSON description file.
+- One or more template files in Handlebars or Underscore format.
+- Any necessary support files (CSS, LaTeX partials, etc.).
+- A dedicated README.
+
+Within its containing folder, a theme can have an arbitrary structure provided you either a) follow a standard naming convention or b) specify your theme files in your theme's JSON file. If you can do `{{ r.name }}` in a template file you
+can work with FRESH themes.
+
+## Contribute
+
+Contributions are welcome.
+
+1. Fork, branch, and clone this repository.
+2. Add or edit a theme or make other changes.
+3. Submit a PR.
 
 ## License
 
@@ -30,3 +47,5 @@ MIT. See [LICENSE.md][1] for details.
 [1]: http://fluentcv.com
 [2]: https://github.com/fluentdesk/fluentcv
 [3]: ../LICENSE.md
+[f]: https://github.com/fluentdesk/FRESCA
+[jrs]: http://jsonresume.org

package.json

@@ -1,6 +1,6 @@
 {
   "name": "fluent-themes",
-  "version": "0.5.1-beta",
+  "version": "0.6.0-beta",
   "description": "Resume themes for FluentCV.",
   "repository": {
     "type": "git",

themes/awesome/README.md

@@ -0,0 +1,38 @@
+Theme: Awesome
+==============
+An experimental FluentCV theme based on the [Awesome-CV][acv] resume
+template for LaTeX.
+
+## Use
+
+1. Run `fluentcv build my-resume.json to out/my-resume.all -t awesome` to create
+a LaTeX resume in the Awesome-CV style using your FRESH or JSON Resume resume.
+
+2. Generate a styled PDF by running `xelatex my-resume.tex` in the `examples`
+folder generated in Step 1. You'll need a valid and updated LaTeX environment on
+your local machine, such as [MiKTeX 2.9.5721][m].
+
+## Warning
+
+For this theme to work the same way the original Awesome-CV theme works, there
+are 3 symlinks in the `examples` folder that need to exist:
+
+- `awesome-cv.cls` should link to `../awesome-cv.cls`.
+- `fontawesome.sty` should link to `../fontawesome.sty`.
+- `fonts` should link to `../fonts` (folder).
+
+FluentCV creates these by default when it generates a resume under the `awesome`
+theme. To create these symlinks manually, either use the Linux / OS X symlink
+command for all three or, if on Windows, run use `mklink /H` for the first two
+and `mklink /J` for the last.
+
+## License
+
+Themes are licensed under MIT. See [LICENSE.md][lic].
+
+
+[acv]: https://github.com/posquit0/Awesome-CV
+[m]: http://miktex.org/download
+[desk]: http://fluentcv.com
+[cli]: https://github.com/fluentdesk/fluentcv
+[lic]: https://github.com/fluentdesk/fluent-themes/blob/master/LICENSE.md

themes/awesome/awesome.json

@@ -0,0 +1,39 @@
+{
+  "title": "compact",
+  "description": "A FluentCV résumé theme based on Awesome-CV for LaTeX.",
+  "engine": "underscore",
+  "delimeters": {
+    "interpolate": "\\[\\[([\\s\\S]+?)\\]\\]",
+    "escape": "\\[\\=([\\s\\S]+?)\\]\\]",
+    "evaluate": "\\[~([\\s\\S]+?)~]",
+    "comment": "\\[\\#([\\s\\S]+?)\\#\\]"
+  },
+  "formats": {
+    "latex": {
+      "transform": [
+        "src/latex/examples/resume.tex",
+        "src/latex/examples/cv.tex",
+        "src/latex/examples/resume/committees.tex",
+        "src/latex/examples/resume/education.tex",
+        "src/latex/examples/resume/experience.tex",
+        "src/latex/examples/resume/extracurricular.tex",
+        "src/latex/examples/resume/honors.tex",
+        "src/latex/examples/resume/presentation.tex",
+        "src/latex/examples/resume/writing.tex",
+        "src/latex/examples/cv/committees.tex",
+        "src/latex/examples/cv/education.tex",
+        "src/latex/examples/cv/experience.tex",
+        "src/latex/examples/cv/extracurricular.tex",
+        "src/latex/examples/cv/honors.tex",
+        "src/latex/examples/cv/presentation.tex",
+        "src/latex/examples/cv/skills.tex",
+        "src/latex/examples/cv/writing.tex"
+      ],
+      "symLinks": {
+        "src/latex/examples/awesome-cv.cls": "../awesome-cv.cls",
+        "src/latex/examples/fontawesome.sty": "../fontawesome.sty",
+        "src/latex/examples/fonts": "../fonts"
+      }
+    }
+  }
+}