jshaver
/
html-resume
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README.md

This commit is contained in:
Min-Zhong "John" Lu 2016-04-09 19:50:07 -04:00
parent 877a92a092
commit df786cb71a
1 changed files with 17 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -1,30 +1,39 @@
# html-resume
A single-page resume template completely typeset with HTML and CSS. Can be typeset into PDF
A single-page résumé template done purely with HTML and CSS, which can be rendered into PDF by web browsers, making a nice, sleek, professsional and ready-to-print résumé. See my living example at: http://mnjul.net/cv/resume.pdf
# Known Issues and Compatibility
*
As the résumé is purely typeset with HTML and CSS, it's highly customizable (e.g. if you want an "objective" section, just copy-paste a few HTML elements) and does not require proprietary software. All you need is a text editor and a web browser (see compatibility section below). Oh, maybe some intermediate CSS knowledge. And, since it's open source with Apache License, you're allowed (and encouraged!) to create your own fine-tuned template and share with others.
# Compatibility and Known Issues
* I have only tested this project on latest release version of Firefox (45) and Google Chrome (49) on OS X 10.11 (El Capitan).
* It's my intention to support other browsers/platforms (like IE Edge on Windows?) as long as the browser sufficiently supports the required CSS features: ``calc()``, ``var()``, ``flexbox``, ...etc, and does not require (too many) dirty tricks. PRs or comments welcome!
* It appears that Google Chrome doesn't show the customized bullet points for the first-column items in two-column lists as in the ``concise`` block (in the example file, the last block of the Education section). You may work around this by reverting back to using built-in ``list-style-type``, or just don't use the two-column lists.
# Fonts, Icon Fonts, and Dependencies
* [Open Sans](https://www.google.com/fonts/specimen/Open+Sans) and [Source Sans Pro](https://www.google.com/fonts/specimen/Source+Sans+Pro) are used at various weights, but are not included in this repository. Please follow the links to download the fonts onto your computer.
* Icons from [Font Awesome] (https://fortawesome.github.io/Font-Awesome/) are used and are incorporated as a git submodule in this repository.
* [Normalize.css] (https://necolas.github.io/normalize.css/) is used and is incorporated as a git submodule in this repository.
# Paper Size/Orientation
* Currently letter portrait only. PRs welcome for other paper sizes --- especially A4!
# Actually Generating the PDF
# Actually Rendering the PDF
* Again...I've only tried on the said version of Firefox & Chrome, on OS X.
* Just open the HTML file with the browser. No need to serve the document from any kind of web server --- the ``file:///`` protocol should be good enough.
* On Firefox:
* You probably need to remove any page margins in **about:config**.
* Uncheck **Ignore Scaling and Shrink To Fit Page Width**.
* Check **Print Background Images**.
* Clear out the headers and footers.
* Save as PDF.
* On Google Chrome:
* Set **Margin** to **None**.
* Print **Background Graphics**.
* Don't print headers and footers.
* Save as PDF.
# Footnotes and License
* If you ever print out the generated PDF, make sure texts are not clipped off, or items have not unexpectedly shrunk. Additionally, since the PDF has no margin outside the shaded sidebar and most printers have a no-print area, the shaded sidebar probably won't fill up to the edge of the page when printed.
* Licensed under the Apache license.
* If you ever print out the rendered PDF, make sure texts are not clipped off, or items have not unexpectedly shrunk. Additionally, since the PDF has no margin outside the shaded sidebar, while most printers have no-print areas, the shaded sidebar probably won't fill up to the page's edge when printed.
* This project is licensed under the Apache License.
* PR, forks and other comments/suggestions are, as always, super welcome.
* Feel free to remove the ``#disclaimer`` block which links back to this repository --- but huge thanks if you decide to keep it.
* This project uses fonts from [Font Awesome](https://fortawesome.github.io/Font-Awesome/). The layout/design inspired by Paolo Zupin (if anyone knows which link I should put under Mr. Zupin's name, please tell me!)
* The layout/design was inspired by Paolo Zupin. Also, if anyone knows which link I should put under Mr. Zupin's name, please tell me!