FIX readme
This commit is contained in:
parent
2400138b0c
commit
597d13f589
18
README.md
18
README.md
@ -13,30 +13,40 @@ A collection of beautiful resumes build with LESS and Mustache Templates. Choose
|
|||||||
<a href="public/preview/resume-5.png"><img src="public/preview/resume-5.png" width="150"/></a>
|
<a href="public/preview/resume-5.png"><img src="public/preview/resume-5.png" width="150"/></a>
|
||||||
<a href="public/preview/resume-6.png"><img src="public/preview/resume-6.png" width="150"/></a>
|
<a href="public/preview/resume-6.png"><img src="public/preview/resume-6.png" width="150"/></a>
|
||||||
|
|
||||||
## Install
|
## How to generate your resumes
|
||||||
|
|
||||||
Follow these instructions to create your own CV:
|
Follow these instructions to create your own CV:
|
||||||
|
|
||||||
- Clone this repository.
|
- Clone this repository.
|
||||||
- Switch to project directory and run `npm install`.
|
- 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.
|
- Replace placeholder image `/public/person.jpg` with your portrait.
|
||||||
- To preview your CV run `npm start`. Check out <http://localhost:3000>.
|
- To preview your CV run `npm start`. Check out <http://localhost:3000>.
|
||||||
- Feel free to adjust styles in `/less` according to your needs.
|
- 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`.
|
- When finished, run `npm run pdf` to generate all CVs as pdf. You will find the generated pdfs in `/pdf`.
|
||||||
|
|
||||||
## Adding a template
|
## Adding a template
|
||||||
|
|
||||||
TODO
|
TODO
|
||||||
|
|
||||||
## How to add a font
|
### Handle box-shadows and drop-shadow
|
||||||
|
|
||||||
TODO
|
TODO
|
||||||
|
|
||||||
|
### How to add a font
|
||||||
|
|
||||||
|
TODO
|
||||||
|
|
||||||
|
|
||||||
## Contribute
|
## Contribute
|
||||||
|
|
||||||
Feel free to create your own templates!
|
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").
|
||||||
|
|||||||
13
index.html
13
index.html
@ -23,25 +23,30 @@
|
|||||||
<a href="public/preview/resume-4.png"><img src="public/preview/resume-4.png" width="150"/></a>
|
<a href="public/preview/resume-4.png"><img src="public/preview/resume-4.png" width="150"/></a>
|
||||||
<a href="public/preview/resume-5.png"><img src="public/preview/resume-5.png" width="150"/></a>
|
<a href="public/preview/resume-5.png"><img src="public/preview/resume-5.png" width="150"/></a>
|
||||||
<a href="public/preview/resume-6.png"><img src="public/preview/resume-6.png" width="150"/></a></p>
|
<a href="public/preview/resume-6.png"><img src="public/preview/resume-6.png" width="150"/></a></p>
|
||||||
<h2 id="install">Install</h2>
|
<h2 id="howtogenerateyourresumes">How to generate your resumes</h2>
|
||||||
<p>Follow these instructions to create your own CV:</p>
|
<p>Follow these instructions to create your own CV:</p>
|
||||||
<ul>
|
<ul>
|
||||||
<li>Clone this repository.</li>
|
<li>Clone this repository.</li>
|
||||||
<li>Switch to project directory and run <code>npm install</code>.</li>
|
<li>Switch to project directory and run <code>npm install</code>.</li>
|
||||||
<li>Adjust your personal information in <code>person.js</code>.</li>
|
<li>Adjust your personal information in <code>/src/person.js</code>.</li>
|
||||||
<li>Replace placeholder image <code>/public/person.jpg</code> with your portrait.</li>
|
<li>Replace placeholder image <code>/public/person.jpg</code> with your portrait.</li>
|
||||||
<li>To preview your CV run <code>npm start</code>. Check out <a href="http://localhost:3000">http://localhost:3000</a>.</li>
|
<li>To preview your CV run <code>npm start</code>. Check out <a href="http://localhost:3000">http://localhost:3000</a>.</li>
|
||||||
<li>Feel free to adjust styles in <code>/less</code> according to your needs.</li>
|
<li>Feel free to adjust styles in <code>/less</code> according to your needs.</li>
|
||||||
|
</ul>
|
||||||
|
<p>If you adjust the less files or <code>/src/person.js</code>, restart application with <code>npm start</code> to view changes.</p>
|
||||||
|
<ul>
|
||||||
<li>When finished, run <code>npm run pdf</code> to generate all CVs as pdf. You will find the generated pdfs in <code>/pdf</code>.</li>
|
<li>When finished, run <code>npm run pdf</code> to generate all CVs as pdf. You will find the generated pdfs in <code>/pdf</code>.</li>
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="addingatemplate">Adding a template</h2>
|
<h2 id="addingatemplate">Adding a template</h2>
|
||||||
<p>TODO</p>
|
<p>TODO</p>
|
||||||
<h2 id="howtoaddafont">How to add a font</h2>
|
<h3 id="handleboxshadowsanddropshadow">Handle box-shadows and drop-shadow</h3>
|
||||||
|
<p>TODO</p>
|
||||||
|
<h3 id="howtoaddafont">How to add a font</h3>
|
||||||
<p>TODO</p>
|
<p>TODO</p>
|
||||||
<h2 id="contribute">Contribute</h2>
|
<h2 id="contribute">Contribute</h2>
|
||||||
<p>Feel free to create your own templates!</p>
|
<p>Feel free to create your own templates!</p>
|
||||||
<hr />
|
<hr />
|
||||||
<p>Icons made by <a href="http://www.flaticon.com/authors/vectors-market" title="Vectors Market">Vectors Market</a> from <a href="http://www.flaticon.com" title="Flaticon">www.flaticon.com</a> is licensed by <a href="http://creativecommons.org/licenses/by/3.0/" title="Creative Commons BY 3.0">CC 3.0 BY</a></p>
|
<p>Icons made by <a href="http://www.flaticon.com/authors/vectors-market" title="Vectors Market">Vectors Market</a> from <a href="http://www.flaticon.com" title="Flaticon">www.flaticon.com</a> is licensed by <a href="http://creativecommons.org/licenses/by/3.0/" title="Creative Commons BY 3.0">CC 3.0 BY</a>.</p>
|
||||||
</div>
|
</div>
|
||||||
<script>
|
<script>
|
||||||
var headline = document.getElementsByTagName('h1')[0];
|
var headline = document.getElementsByTagName('h1')[0];
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user