mirror of
https://github.com/JuanCanham/HackMyResume.git
synced 2024-12-23 05:37:23 +00:00
Capture CHANGELOG and FAQ.
This commit is contained in:
parent
915f35b1e6
commit
ac9e4aa1a0
83
CHANGELOG.md
83
CHANGELOG.md
@ -2,21 +2,27 @@ CHANGELOG
|
||||
=========
|
||||
## v1.6.0
|
||||
|
||||
### Added
|
||||
### Major Improvements
|
||||
|
||||
- Improved consistency and coverage for all FRESH themes.
|
||||
- Better consistency and coverage for all FRESH resumes and themes ([#45][i45]).
|
||||
|
||||
- Support for new `projects` and `affiliations` resume sections.
|
||||
- Initial support for overridable fonts in FRESH themes. Like a particular
|
||||
theme, but want to change the typography? The specific fonts used by a theme
|
||||
can now be overridden by the user. (FRESH themes only).
|
||||
|
||||
- Better handling of start and end dates on `employment`, `projects`,
|
||||
`education`, and other sections with start/end dates. A missing or empty
|
||||
end date will be interpreted as "currently employed/engaged/involved with
|
||||
the job/project/education", as will the words "current", "present", or "new".
|
||||
- New resume sections! Support for `projects` and `affiliation` resume sections
|
||||
for technical and creative projects and memberships / clubs / associations,
|
||||
respectively ([#92][i92]).
|
||||
|
||||
- New command! `PEEK` at any arbitrary field or entry on your `.json` resume.
|
||||
|
||||
- Annotated the HTML and MS Word (XML) formats of the Modern theme for FRESH
|
||||
theme authors.
|
||||
### Added
|
||||
|
||||
- Improved handling of start and end dates on `employment`, `projects`,
|
||||
`education`, and other sections with start/end dates.
|
||||
|
||||
- Support for an `.ignore` property on any FRESH or JSON Resume section or field.
|
||||
Ignored properties will be treated by HackMyResume as if they weren't present.
|
||||
|
||||
- Emit extended status and error info with the `--debug` or `-d` switch.
|
||||
|
||||
@ -33,9 +39,12 @@ in your resume `.json` file.
|
||||
|
||||
- Improvements to the starter resume emitted by `hackmyresume new`.
|
||||
|
||||
- Refactored colors in HackMyResume output. Errors will now display as red,
|
||||
warnings as yellow, successful operations as green, and informational warnings
|
||||
as cyan. Similar to the color scheme used by Bootstrap.
|
||||
- Theme Authoring: Annotated the HTML and MS Word (XML) formats of the Modern
|
||||
theme for FRESH theme authors.
|
||||
|
||||
- Theme Authoring: Support for templatized CSS files in FRESH themes. CSS files
|
||||
are now expanded via Handlebars or Underscore prior to copying to the
|
||||
destination.
|
||||
|
||||
- Added CHANGELOG.md (this file).
|
||||
|
||||
@ -43,20 +52,47 @@ as cyan. Similar to the color scheme used by Bootstrap.
|
||||
|
||||
- Rewrote the HackMyResume man/help page.
|
||||
|
||||
- Minor updates to the FRESCA schema.
|
||||
- Minor incremental updates to the [FRESCA][fresca] schema.
|
||||
|
||||
- PDF generation now uses asynchronous `spawn()` which has better compatibility
|
||||
with old or boutique versions of Node.js. Synchronous spawn is preserved as an
|
||||
internal code path.
|
||||
with old or boutique versions of Node.js.
|
||||
|
||||
- Refactored colors in HackMyResume output. Errors will now display as red,
|
||||
warnings as yellow, successful operations as green, and informational messages
|
||||
as cyan.
|
||||
|
||||
- Theme messages and usage tips will no longer display during resume generation
|
||||
by default. Use the `--tips` option to view them.
|
||||
|
||||
- The `--no-tips` option (default: false) has been replaced with the `--tips`
|
||||
option, also defaulting to false.
|
||||
|
||||
- Removed the `hello-world` theme from the [prebuilt themes][themes] that ship
|
||||
with HackMyResume. It can be installed separately from NPM:
|
||||
|
||||
```bash
|
||||
npm install fresh-theme-hello-world
|
||||
hackmyresume resume.json -t node_modules/fresh-theme-hello-world
|
||||
```
|
||||
|
||||
- sd
|
||||
|
||||
### Fixed
|
||||
|
||||
- Issue with synchronous spawning of PDF generation process on older
|
||||
versions of Node.
|
||||
- PDF generation issues on older versions of Node.
|
||||
|
||||
- Issue with stack traces not being emitted correctly when needed.
|
||||
- Stack traces not being emitted correctly.
|
||||
|
||||
- Issue with `speaking` section not appearing on generated resume.
|
||||
- Missing `speaking` section will now appear on generated resumes ([#101][i101]).
|
||||
|
||||
- Incomplete `education` details will now appear on generated resumes ([#65][i65]).
|
||||
|
||||
- Missing employment end date being interpreted as "employment ends today"
|
||||
([#84][i84]).
|
||||
|
||||
- Merging multiple source resumes during `BUILD` sometimes fails.
|
||||
|
||||
- Document `--pdf` flag in README ([#111][i111]).
|
||||
|
||||
### Internal
|
||||
|
||||
@ -259,3 +295,12 @@ theme.
|
||||
## v1.0.0
|
||||
|
||||
- Initial public 1.0 release.
|
||||
|
||||
[i45]: https://github.com/hacksalot/HackMyResume/issues/45
|
||||
[i65]: https://github.com/hacksalot/HackMyResume/issues/65
|
||||
[i84]: https://github.com/hacksalot/HackMyResume/issues/84
|
||||
[i92]: https://github.com/hacksalot/HackMyResume/issues/92
|
||||
[i101]: https://github.com/hacksalot/HackMyResume/issues/101
|
||||
[i111]: https://github.com/hacksalot/HackMyResume/issues/111
|
||||
[fresca]: https://github.com/fluentdesk/FRESCA
|
||||
[themes]: https://github.com/fluentdesk/fresh-themes
|
||||
|
112
FAQ.md
112
FAQ.md
@ -9,19 +9,29 @@ Frequently Asked Questions (FAQ)
|
||||
|
||||
3. Test with `hackmyresume BUILD <resume-name>.json`. Look in the `out/` folder.
|
||||
|
||||
4. Play around with different themes with the `-t` or `--theme` parameter. You can use any [FRESH](https://github.com/fluentdesk/fresh-themes) or [JSON Resume](https://jsonresume.org/themes) theme. The latter have to be installed first.
|
||||
4. Play around with different themes with the `-t` or `--theme` parameter.
|
||||
You can use any [FRESH](https://github.com/fluentdesk/fresh-themes) or
|
||||
[JSON Resume](https://jsonresume.org/themes) theme. The latter have to be
|
||||
installed first.
|
||||
|
||||
## What is FRESH?
|
||||
|
||||
FRESH is the **F**luent **R**esume and **E**mployment **S**ystem for **H**umans. It's an open-source, user-first workflow, schema, and set of practices for technical candidates and recruiters.
|
||||
FRESH is the **F**luent **R**esume and **E**mployment **S**ystem for **H**umans.
|
||||
It's an open-source, user-first workflow, schema, and set of practices for
|
||||
technical candidates and recruiters.
|
||||
|
||||
## What is FRESCA?
|
||||
|
||||
The **F**RESH **R**esume and **E**mployment **SC**hem**A**—an open-source, JSON-driven schema for resumes, CVs, and other employment artifacts. FRESCA is the recommended schema/format for FRESH, with optional support for JSON Resume.
|
||||
The **F**RESH **R**esume and **E**mployment **SC**hem**A**—an open-source,
|
||||
JSON-driven schema for resumes, CVs, and other employment artifacts. FRESCA is
|
||||
the recommended schema/format for FRESH, with optional support for JSON Resume.
|
||||
|
||||
## What is JSON Resume?
|
||||
|
||||
An [open resume standard](http://jsonresume.org/themes/) sponsored by Hired.com. Like FRESCA, JSON Resume is JSON-driven and open-source. Unlike FRESCA, JSON Resume targets a worldwide audience where FRESCA is optimized for technical candidates.
|
||||
An [open resume standard](http://jsonresume.org/themes/) sponsored by Hired.com.
|
||||
Like FRESCA, JSON Resume is JSON-driven and open-source. Unlike FRESCA, JSON
|
||||
Resume targets a worldwide audience where FRESCA is optimized for technical
|
||||
candidates.
|
||||
|
||||
## Should I use the FRESH or JSON Resume format/schema for my resume?
|
||||
|
||||
@ -31,24 +41,45 @@ Both! The workflow we like to use:
|
||||
2. Convert it to JSON Resume format for additional themes/tools.
|
||||
3. Maintain both versions.
|
||||
|
||||
Both formats are open-source and both formats are JSON-driven. FRESH was designed as a universal container format and superset of existing formats, where the JSON Resume format is intended for a generic audience.
|
||||
Both formats are open-source and both formats are JSON-driven. FRESH was
|
||||
designed as a universal container format and superset of existing formats, where
|
||||
the JSON Resume format is intended for a generic audience.
|
||||
|
||||
## How do I use a FRESH theme?
|
||||
|
||||
FRESH themes currently come preinstalled with HackMyResume.
|
||||
Several FRESH themes come preinstalled with HackMyResume; others can be
|
||||
installed from NPM and GitHub.
|
||||
|
||||
1. Specify the theme name in the `--theme` or `-t` parameter to the **build** command:
|
||||
### To use a preinstalled FRESH theme:
|
||||
|
||||
1. Pass the theme name into HackMyResume via the `--theme` or `-t` parameter:
|
||||
|
||||
```bash
|
||||
hackmyresume BUILD my-resume.json --theme <theme-name>
|
||||
hackmyresume build resume.json --theme compact
|
||||
```
|
||||
|
||||
`<theme-name>` can be one of `positive`, `compact`, `modern`, `minimist`, `hello-world`, or `awesome`.
|
||||
### To use an external FRESH theme:
|
||||
|
||||
2. Check your output folder. Although under FRESH, HTML formats are hardened to a degree for local file access, it's best to view HTML formats over a local web server connection.
|
||||
1. Install the theme locally. The easiest way to do that is with NPM.
|
||||
|
||||
```bash
|
||||
npm install fresh-theme-underscore
|
||||
```
|
||||
|
||||
2. Pass the theme folder into HackMyResume:
|
||||
|
||||
```bash
|
||||
hackmyresume BUILD resume.json --theme node_modules/fresh-theme-underscore
|
||||
```
|
||||
|
||||
3. Check your output folder. It's best to view HTML formats over a local web
|
||||
server connection.
|
||||
|
||||
## How do I use a JSON Resume theme?
|
||||
|
||||
JSON Resume (JRS) themes can be installed from NPM and GitHub and passed into
|
||||
HackMyResume via the `--theme` or `-t` parameter.
|
||||
|
||||
1. Install the theme locally. The easiest way to do that is with NPM.
|
||||
|
||||
```bash
|
||||
@ -61,15 +92,19 @@ FRESH themes currently come preinstalled with HackMyResume.
|
||||
hackmyresume BUILD resume.json --theme node_modules/jsonresume-theme-classy
|
||||
```
|
||||
|
||||
3. Check your output folder. It's best to view HTML formats over a local web server connection.
|
||||
3. Check your output folder. It's best to view HTML formats over a local web
|
||||
server connection.
|
||||
|
||||
## Should I keep my resume in version control?
|
||||
|
||||
Absolutely! As text-based, JSON-driven documents, both FRESH and JSON Resume are ideal candidates for version control. Future versions of HackMyResume will have this functionality built-in.
|
||||
Absolutely! As text-based, JSON-driven documents, both FRESH and JSON Resume are
|
||||
ideal candidates for version control. Future versions of HackMyResume will have
|
||||
this functionality built in.
|
||||
|
||||
## Can I change the default section titles ("Employment", "Skills", etc.)?
|
||||
|
||||
If you're using a FRESH theme, yes. First, create a HackMyResume options file mapping resume sections to your preferred section title:
|
||||
If you're using a FRESH theme, yes. First, create a HackMyResume options file
|
||||
mapping resume sections to your preferred section title:
|
||||
|
||||
```javascript
|
||||
// myoptions.json
|
||||
@ -90,6 +125,57 @@ hackmyresume BUILD resume.json -o myoptions.json
|
||||
|
||||
This ability is currently only supported for FRESH resume themes.
|
||||
|
||||
## How does resume merging work?
|
||||
|
||||
Resume merging is a way of storing your resume in separate files that
|
||||
HackMyResume will merge into a single "master" resume file prior to generating
|
||||
specific output formats like HTML or PDF. It's a way of producing flexible,
|
||||
configurable, targeted resumes with minimal duplication.
|
||||
|
||||
For example, a software developer who moonlights as a game programmer might
|
||||
create three FRESH or JRS resumes at different levels of specificity:
|
||||
|
||||
- **generic.json**: A generic technical resume, suitable for all audiences.
|
||||
- **game-developer.json**: Overrides and amendments for game developer
|
||||
positions.
|
||||
- **blizzard.json**: Overrides and amendments specific to a hypothetical
|
||||
position at Blizzard.
|
||||
|
||||
If you run `hackmyresume BUILD generic.json TO out/resume.all`, HMR will
|
||||
generate all available output formats for the `generic.json` as usual. But if
|
||||
you instead run...
|
||||
|
||||
```bash
|
||||
hackmyresume BUILD generic.json game-developer.json TO out/resume.all
|
||||
```
|
||||
|
||||
...HackMyResume will notice that multiple source resumes were specified and
|
||||
merge `game-developer.json` onto `generic.json` before generating, yielding a
|
||||
resume that's more suitable for game-developer-related positions.
|
||||
|
||||
You can take this a step further. Let's say you want to do a targeted resume
|
||||
submission to a game developer position at Blizzard, and `blizzard.json`
|
||||
contains the edits and revisions you'd like to show up in the targeted resume.
|
||||
In that case, merge again! Feed all three resumes to HackMyResume, in order
|
||||
from most generic to most specific, and HMR will merge them all prior to
|
||||
generating the final output format(s) for your resume.
|
||||
|
||||
```bash
|
||||
# Merge blizzard.json onto game-developer.json onto generic.json, then build
|
||||
hackmyresume BUILD generic.json game-developer.json blizzard.json TO out/resume.all
|
||||
```
|
||||
|
||||
There's no limit to the number of resumes you can merge this way.
|
||||
|
||||
You can also divide your resume into files containing different sections:
|
||||
|
||||
- **resume-a.json**: Contains `info`, `employment`, and `summary` sections.
|
||||
- **resume-b.json**: Contains all other sections except `references`.
|
||||
- **references.json**: Contains the private `references` section.
|
||||
|
||||
Under that scenario, `hackmyresume BUILD resume-a.json resume-b.json` would
|
||||
|
||||
|
||||
## The HackMyResume terminal color scheme is giving me a headache. Can I disable it?
|
||||
|
||||
Yes. Use the `--no-color` option to disable terminal colors:
|
||||
|
Loading…
Reference in New Issue
Block a user