fresh-themes/README.md

64 lines
2.4 KiB
Markdown
Raw Normal View History

2015-10-26 17:36:18 +00:00
fluent-themes
=============
2015-12-19 13:56:15 +00:00
2015-12-09 14:09:20 +00:00
Stylized templates for your résumé and/or CV, compatible with [FRESH][f] and
[JSON Resume][jrs] formats.
2015-10-10 22:45:29 +01:00
2015-12-19 13:56:15 +00:00
- [positive][t-positive]: A visually dense/compact theme.
- [modern][t-modern]: A middle of the road theme with a modern look 'n feel.
- [compact][t-compact]: A visually dense/compact theme.
- [awesome][t-awesome]: A technical resume theme based on [Awesome-CV][awe].
- [minimist][t-minimist]: An unstyled barebones theme.
- [hello-world][t-hello]: A simple-as-possible example theme.
2015-12-09 14:09:20 +00:00
- New themes weekly.
2015-10-10 22:45:29 +01:00
2015-12-09 14:09:20 +00:00
## Install
2015-10-10 22:45:29 +01:00
2015-12-09 14:09:20 +00:00
You don't need to install this repository to use the themes; just install
2015-12-19 13:56:15 +00:00
[FluentCV Desktop][1] or [Command Line][2]. Otherwise you can install the latest
official standalone version of the theme repository over NPM...
2015-10-10 22:45:29 +01:00
2015-12-09 14:09:20 +00:00
`[sudo] npm install fluent-themes --save`
2015-10-10 22:45:29 +01:00
2015-12-09 14:09:20 +00:00
...or fork and clone it as usual.
2015-10-10 22:45:29 +01:00
2015-12-09 14:09:20 +00:00
## Structure
2015-10-10 22:45:29 +01:00
2015-12-09 14:09:20 +00:00
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.
2015-12-19 13:56:15 +00:00
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
2015-12-09 14:09:20 +00:00
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.
2015-10-06 19:20:47 +01:00
## License
2015-10-10 22:45:29 +01:00
MIT. See [LICENSE.md][1] for details.
2015-10-06 19:20:47 +01:00
[1]: http://fluentcv.com
2015-10-28 03:46:36 +00:00
[2]: https://github.com/fluentdesk/fluentcv
2015-12-19 13:56:15 +00:00
[3]: https://github.com/fluentdesk/fluent-themes/blob/master/LICENSE.md
2015-12-09 14:09:20 +00:00
[f]: https://github.com/fluentdesk/FRESCA
[jrs]: http://jsonresume.org
2015-12-11 08:52:12 +00:00
[awe]: https://github.com/posquit0/Awesome-CV
2015-12-19 13:56:15 +00:00
[t-awesome]: https://github.com/fluentdesk/fluent-themes/tree/master/themes/awesome
[t-minimist]: https://github.com/fluentdesk/fluent-themes/tree/master/themes/minimist
[t-modern]: https://github.com/fluentdesk/fluent-themes/tree/master/themes/modern
[t-hello]: https://github.com/fluentdesk/fluent-themes/tree/master/themes/hello-world
[t-compact]: https://github.com/fluentdesk/fluent-themes/tree/master/themes/compact
[t-positive]: https://github.com/fluentdesk/fluent-themes/tree/master/themes/positive