JuanCanham/HackMyResume
1
0
Fork 0
mirror of https://github.com/JuanCanham/HackMyResume.git synced 2024-11-21 16:00:11 +00:00
Code Issues Releases Wiki Activity

Update README.

Browse Source
This commit is contained in:
James Devlin 2015-09-01 20:14:24 -04:00
parent 2aeec2334f
commit 818a071433
1 changed files with 59 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
README.md
View File

@ -1,9 +1,67 @@
scrappy
=======
Scrappy (code-name) is the HMR command-line application for OS X, Windows, and Linux.
The original Node.js-based proof-of-concept command line tool for **FluentCV**.
## Use
First make sure [Node.js][4] and [NPM][5] are installed. Then:
1. Install the latest official [PhantomJS][2] and [wkhtmltopdf][3] binaries for your platform.
2. Verify PhantomJS and wkhtml are accessible on your path.
3. Run `npm install` followed by `npm link`.
4. Run Scrappy from with `scrappy [input] [output] -t [theme]`. For example:
```bash
# Generate all resume formats (HTML, PDF, DOC, TXT)
scrappy resume.json resume.all -t informatic
# Generate a specific resume format
scrappy resume.json resume.html -t informatic
scrappy resume.json resume.txt -t informatic
scrappy resume.json resume.pdf -t informatic
scrappy resume.json resume.doc -t informatic
```
5. Success looks like this:
```
*** Scrappy v0.1.0 ***
Reading JSON resume: foo/resume.json
Generating HTML resume: out/resume.html
Generating TXT resume: out/resume.txt
Generating DOC resume: out/resume.doc
Generating PDF resume: out/resume.pdf
```
## Advanced
You can **merge multiple resumes** by specifying them in order from most generic to most specific:
```bash
# Merge specific.json onto base.json and generate all formats
scrappy base.json specific.json resume.all -t informatic
```
You can specify **multiple output filenames** instead of using `.all`:
```bash
# Merge specific.json onto base.json and generate r1.doc and r2.pdf
scrappy base.json specific.json r1.doc r2.pdf -t informatic
```
You can omit the output file(s) and/or theme completely:
```bash
# Equivalent to "scrappy resume.json resume.all -t default"
scrappy resume.json
```
## License
Proprietary and confidential. See [LICENSE.md][1] for details.
[1]: LICENSE.md
[2]: http://phantomjs.org/
[3]: http://wkhtmltopdf.org/
[4]: https://nodejs.org/
[5]: https://www.npmjs.com/