From 597d13f589afd7905eb1efd30bb6c40940cfb997 Mon Sep 17 00:00:00 2001 From: unpregnant Date: Mon, 6 Feb 2017 22:09:34 +0100 Subject: [PATCH] FIX readme --- README.md | 18 ++++++++++++++---- index.html | 13 +++++++++---- 2 files changed, 23 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index c114747..e86bf32 100755 --- a/README.md +++ b/README.md @@ -13,30 +13,40 @@ A collection of beautiful resumes build with LESS and Mustache Templates. Choose -## Install +## How to generate your resumes Follow these instructions to create your own CV: - Clone this repository. - Switch to project directory and run `npm install`. -- Adjust your personal information in `person.js`. +- Adjust your personal information in `/src/person.js`. - Replace placeholder image `/public/person.jpg` with your portrait. - To preview your CV run `npm start`. Check out . - Feel free to adjust styles in `/less` according to your needs. + +If you adjust the less files or `/src/person.js`, restart application with `npm start` to view changes. + - When finished, run `npm run pdf` to generate all CVs as pdf. You will find the generated pdfs in `/pdf`. ## Adding a template TODO -## How to add a font +### Handle box-shadows and drop-shadow TODO +### How to add a font + +TODO + + ## Contribute Feel free to create your own templates! + + -------------------------------------------------------------------------------- -Icons made by [Vectors Market](http://www.flaticon.com/authors/vectors-market "Vectors Market") from [www.flaticon.com](http://www.flaticon.com "Flaticon") is licensed by [CC 3.0 BY](http://creativecommons.org/licenses/by/3.0/ "Creative Commons BY 3.0") +Icons made by [Vectors Market](http://www.flaticon.com/authors/vectors-market "Vectors Market") from [www.flaticon.com](http://www.flaticon.com "Flaticon") is licensed by [CC 3.0 BY](http://creativecommons.org/licenses/by/3.0/ "Creative Commons BY 3.0"). diff --git a/index.html b/index.html index 4ca9800..fc8cb78 100755 --- a/index.html +++ b/index.html @@ -23,25 +23,30 @@

-

Install

+

How to generate your resumes

Follow these instructions to create your own CV:

+

If you adjust the less files or /src/person.js, restart application with npm start to view changes.

+

Adding a template

TODO

-

How to add a font

+

Handle box-shadows and drop-shadow

+

TODO

+

How to add a font

TODO

Contribute

Feel free to create your own templates!


-

Icons made by Vectors Market from www.flaticon.com is licensed by CC 3.0 BY

+

Icons made by Vectors Market from www.flaticon.com is licensed by CC 3.0 BY.