JuanCanham/fresh-themes
1
0
Fork 0
mirror of https://github.com/JuanCanham/fresh-themes.git synced 2024-11-22 08:10:10 +00:00
Code Issues Releases Wiki Activity

Update README.

Browse Source
This commit is contained in:
hacksalot 2015-12-19 08:56:15 -05:00
parent 2e80657db2
commit 82c80fb222
1 changed files with 19 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -1,19 +1,22 @@
fluent-themes fluent-themes
============= =============
Stylized templates for your résumé and/or CV, compatible with [FRESH][f] and Stylized templates for your résumé and/or CV, compatible with [FRESH][f] and
[JSON Resume][jrs] formats. [JSON Resume][jrs] formats.
- `awesome`: A technical resume theme based on [Awesome-CV][awe]. - [positive][t-positive]: A visually dense/compact theme.
- `minimist`: An unstyled barebones theme. - [modern][t-modern]: A middle of the road theme with a modern look 'n feel.
- `modern`: A middle of the road theme with a modern look 'n feel. - [compact][t-compact]: A visually dense/compact theme.
- `hello-world`: A simple-as-possible example theme. - [awesome][t-awesome]: A technical resume theme based on [Awesome-CV][awe].
- `compact`: A visually dense/compact theme. - [minimist][t-minimist]: An unstyled barebones theme.
- [hello-world][t-hello]: A simple-as-possible example theme.
- New themes weekly. - New themes weekly.
## Install ## Install
You don't need to install this repository to use the themes; just install 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... [FluentCV Desktop][1] or [Command Line][2]. Otherwise you can install the latest
official standalone version of the theme repository over NPM...
`[sudo] npm install fluent-themes --save` `[sudo] npm install fluent-themes --save`
@ -29,7 +32,9 @@ multiple formats. Each theme lives in a separate folder and consists of:
- Any necessary support files (CSS, LaTeX partials, etc.). - Any necessary support files (CSS, LaTeX partials, etc.).
- A dedicated README. - 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 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. can work with FRESH themes.
## Contribute ## Contribute
@ -46,7 +51,13 @@ MIT. See [LICENSE.md][1] for details.
[1]: http://fluentcv.com [1]: http://fluentcv.com
[2]: https://github.com/fluentdesk/fluentcv [2]: https://github.com/fluentdesk/fluentcv
[3]: ../LICENSE.md [3]: https://github.com/fluentdesk/fluent-themes/blob/master/LICENSE.md
[f]: https://github.com/fluentdesk/FRESCA [f]: https://github.com/fluentdesk/FRESCA
[jrs]: http://jsonresume.org [jrs]: http://jsonresume.org
[awe]: https://github.com/posquit0/Awesome-CV [awe]: https://github.com/posquit0/Awesome-CV
[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