mirror of
https://github.com/JuanCanham/HackMyResume.git
synced 2024-11-05 09:56:22 +00:00
Update FAQ and README.
This commit is contained in:
parent
f3dcbd9081
commit
971d4a5439
49
FAQ.md
49
FAQ.md
@ -40,7 +40,7 @@ FRESH themes currently come preinstalled with HackMyResume.
|
|||||||
1. Specify the theme name in the `--theme` or `-t` parameter to the **build** command:
|
1. Specify the theme name in the `--theme` or `-t` parameter to the **build** command:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
hackmyresume BUILD my-resume.json --theme <theme-name>`
|
hackmyresume BUILD my-resume.json --theme <theme-name>
|
||||||
```
|
```
|
||||||
|
|
||||||
`<theme-name>` can be one of `positive`, `compact`, `modern`, `minimist`, `hello-world`, or `awesome`.
|
`<theme-name>` can be one of `positive`, `compact`, `modern`, `minimist`, `hello-world`, or `awesome`.
|
||||||
@ -90,8 +90,53 @@ hackmyresume BUILD resume.json -o myoptions.json
|
|||||||
|
|
||||||
This ability is currently only supported for FRESH resume themes.
|
This ability is currently only supported for FRESH resume themes.
|
||||||
|
|
||||||
## The HackMyResume terminal color scheme is giving me a headache! Can I disable it?
|
## The HackMyResume terminal color scheme is giving me a headache. Can I disable it?
|
||||||
|
|
||||||
Yes. Use the `--no-color` option to disable terminal colors:
|
Yes. Use the `--no-color` option to disable terminal colors:
|
||||||
|
|
||||||
`hackmyresume <somecommand> <someoptions> --no-color`
|
`hackmyresume <somecommand> <someoptions> --no-color`
|
||||||
|
|
||||||
|
## What's the difference between a FRESH theme and a JSON Resume theme?
|
||||||
|
|
||||||
|
FRESH themes are multiformat (HTML, Word, PDF, etc.) and required to support
|
||||||
|
Markdown formatting, configurable section titles, and various other features.
|
||||||
|
|
||||||
|
JSON Resume themes are typically HTML-driven, but capable of expansion to other
|
||||||
|
formats through tools. JSON Resume themes don't support Markdown natively, but
|
||||||
|
HMR does its best to apply your Markdown, when present, to any JSON Resume
|
||||||
|
themes it encounters.
|
||||||
|
|
||||||
|
## Do I have to have a FRESH resume to use a FRESH theme or a JSON Resume to use a JSON Resume theme?
|
||||||
|
|
||||||
|
No. You can mix and match FRESH and JRS-format themes freely. HackMyResume will
|
||||||
|
perform the necessary conversions on the fly.
|
||||||
|
|
||||||
|
## Can I build my own custom FRESH theme?
|
||||||
|
|
||||||
|
Yes. The easiest way is to copy an existing FRESH theme, like `modern` or
|
||||||
|
`compact`, and make your changes there. You can test your theme with:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
hackmyresume build resume.json --theme path/to/my/theme/folder
|
||||||
|
```
|
||||||
|
|
||||||
|
## Can I build my own custom JSON Resume theme?
|
||||||
|
|
||||||
|
Yes. The easiest way is to copy an existing JSON Rsume theme and make your
|
||||||
|
changes there. You can test your theme with:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
hackmyresume build resume.json --theme path/to/my/theme/folder
|
||||||
|
```
|
||||||
|
|
||||||
|
## Can I build my own tools / services / apps / websites around FRESH / FRESCA?
|
||||||
|
|
||||||
|
Yes! FRESH/FRESCA formats are 100% open source, permissively licensed under MIT,
|
||||||
|
and 100% free from company-specific, tool-specific, or commercially oriented
|
||||||
|
lock-in or cruft. These are clean formats designed for users and builders.
|
||||||
|
|
||||||
|
## Can I build my own tools / services / apps / websites around JSON Resume?
|
||||||
|
|
||||||
|
Yes! HackMyResume is not affiliated with JSON Resume, but like FRESH/FRESCA,
|
||||||
|
JSON Resume is open-source, permissively licensed, and free of proprietary
|
||||||
|
lock-in. See the JSON Resume website for details.
|
||||||
|
13
README.md
13
README.md
@ -50,13 +50,22 @@ Install the latest stable version of HackMyResume with NPM:
|
|||||||
[sudo] npm install hackmyresume -g
|
[sudo] npm install hackmyresume -g
|
||||||
```
|
```
|
||||||
|
|
||||||
Power users can install the latest bleeding-edge version (updated daily):
|
Alternately, install the latest bleeding-edge version (updated daily):
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
[sudo] npm install hacksalot/hackmyresume#dev -g
|
[sudo] npm install hacksalot/hackmyresume#dev -g
|
||||||
```
|
```
|
||||||
|
|
||||||
**For PDF generation**, you'll need to install a copy of [wkhtmltopdf][3] and/or PhantomJS for your platform.
|
## Installing PDF Support (optional)
|
||||||
|
|
||||||
|
HackMyResume tries not to impose a specific PDF engine requirement on
|
||||||
|
the user, but will instead work with whatever PDF engines you have installed.
|
||||||
|
|
||||||
|
Currently, HackMyResume's PDF generation requires either [Phantom.js][2] or
|
||||||
|
[wkhtmltopdf][3] to be installed on your system and the `phantomjs` and/or
|
||||||
|
`wkhtmltopdf` binaries to be accessible on your PATH. This is an optional
|
||||||
|
requirement for users who care about PDF formats. If you don't care about PDF
|
||||||
|
formats, skip this step.
|
||||||
|
|
||||||
## Installing Themes
|
## Installing Themes
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user