JuanCanham/HackMyResume
1
0
Fork 0
mirror of https://github.com/JuanCanham/HackMyResume.git synced 2024-09-28 20:19:12 +01:00
Code Issues Releases Wiki Activity

Merge pull request #12 from fluentdesk/feat/rename

Browse Source 
Rename "FluentCMD" to "FluentCV".
This commit is contained in:
JD 2015-10-27 03:51:22 -04:00
commit 090b8a271a
5 changed files with 41 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
README.md
View File

@ -1,10 +1,10 @@
fluentcmd fluentCV
========= ========
*Generate beautiful, targeted resumes from your command line or shell.* *Generate beautiful, targeted resumes from your command line or shell.*
FluentCMD is a **hackable, data-driven, dev-friendly resume authoring tool** with support for HTML, Markdown, Word, PDF, plain text, smoke signal, carrier pigeon, and other arbitrary-format resumes and CVs. FluentCV is a **hackable, data-driven, dev-friendly resume authoring tool** with support for HTML, Markdown, Word, PDF, plain text, smoke signal, carrier pigeon, and other arbitrary-format resumes and CVs.
![](assets/fluentcmd_ubuntu.png) ![](assets/fluentcv_cli_ubuntu.png)
Looking for a desktop GUI version with pretty timelines and graphs? Check out [FluentCV Desktop][7]. Looking for a desktop GUI version with pretty timelines and graphs? Check out [FluentCV Desktop][7].
@ -22,10 +22,10 @@ Looking for a desktop GUI version with pretty timelines and graphs? Check out [F
## Install ## Install
FluentCMD requires a recent version of [Node.js][4] and [NPM][5]. Then: FluentCV requires a recent version of [Node.js][4] and [NPM][5]. Then:
1. (Optional, for PDF support) Install the latest official [wkhtmltopdf][3] binary for your platform. 1. (Optional, for PDF support) Install the latest official [wkhtmltopdf][3] binary for your platform.
2. Install **fluentcmd** by running `npm install fluentcmd -g`. 2. Install **fluentCV** by running `npm install fluentcv -g`.
3. You're ready to go. 3. You're ready to go.
## Use ## Use
@ -33,32 +33,32 @@ FluentCMD requires a recent version of [Node.js][4] and [NPM][5]. Then:
Assuming you've got a JSON-formatted resume handy, generating resumes in different formats and combinations easy. Just run: Assuming you've got a JSON-formatted resume handy, generating resumes in different formats and combinations easy. Just run:
```bash ```bash
fluentcmd [inputs] [outputs] [-t theme]. fluentcv [inputs] [outputs] [-t theme].
``` ```
Where `[inputs]` is one or more .json resume files, separated by spaces; `[outputs]` is one or more destination resumes, each prefaced with the `-o` option; and `[theme]` is the desired theme. For example: Where `[inputs]` is one or more .json resume files, separated by spaces; `[outputs]` is one or more destination resumes, each prefaced with the `-o` option; and `[theme]` is the desired theme. For example:
```bash ```bash
# Generate all resume formats (HTML, PDF, DOC, TXT, YML, etc.) # Generate all resume formats (HTML, PDF, DOC, TXT, YML, etc.)
fluentcmd resume.json -o out/resume.all -t modern fluentcv resume.json -o out/resume.all -t modern
# Generate a specific resume format # Generate a specific resume format
fluentcmd resume.json -o out/resume.html fluentcv resume.json -o out/resume.html
fluentcmd resume.json -o out/resume.pdf fluentcv resume.json -o out/resume.pdf
fluentcmd resume.json -o out/resume.md fluentcv resume.json -o out/resume.md
fluentcmd resume.json -o out/resume.doc fluentcv resume.json -o out/resume.doc
fluentcmd resume.json -o out/resume.json fluentcv resume.json -o out/resume.json
fluentcmd resume.json -o out/resume.txt fluentcv resume.json -o out/resume.txt
fluentcmd resume.json -o out/resume.yml fluentcv resume.json -o out/resume.yml
# Specify 2 inputs and 3 outputs # Specify 2 inputs and 3 outputs
fluentcmd in1.json in2.json -o out.html -o out.doc -o out.pdf fluentcv in1.json in2.json -o out.html -o out.doc -o out.pdf
``` ```
You should see something to the effect of: You should see something to the effect of:
``` ```
*** FluentCMD v0.6.0 *** *** FluentCV v0.7.0 ***
Reading JSON resume: foo/resume.json Reading JSON resume: foo/resume.json
Applying MODERN Theme (7 formats) Applying MODERN Theme (7 formats)
Generating HTML resume: out/resume.html Generating HTML resume: out/resume.html
@ -77,11 +77,11 @@ Generating YAML resume: out/resume.yml
You can specify a predefined or custom theme via the optional `-t` parameter. For a predefined theme, include the theme name. For a custom theme, include the path to the custom theme's folder. You can specify a predefined or custom theme via the optional `-t` parameter. For a predefined theme, include the theme name. For a custom theme, include the path to the custom theme's folder.
```bash ```bash
fluentcmd resume.json -t modern fluentcv resume.json -t modern
fluentcmd resume.json -t ~/foo/bar/my-custom-theme/ fluentcv resume.json -t ~/foo/bar/my-custom-theme/
``` ```
As of v0.6.0, available predefined themes are `modern`, `minimist`, and `hello-world`. As of v0.7.0, available predefined themes are `modern`, `minimist`, and `hello-world`.
### Merging resumes ### Merging resumes
@ -89,13 +89,13 @@ You can **merge multiple resumes together** by specifying them in order from mos
```bash ```bash
# Merge specific.json onto base.json and generate all formats # Merge specific.json onto base.json and generate all formats
fluentcmd base.json specific.json -o resume.all fluentcv base.json specific.json -o resume.all
``` ```
This can be useful for overriding a base (generic) resume with information from a specific (targeted) resume. For example, you might override your generic catch-all "software developer" resume with specific details from your targeted "game developer" resume, or combine two partial resumes into a "complete" resume. Merging follows conventional [extend()][9]-style behavior and there's no arbitrary limit to how many resumes you can merge: This can be useful for overriding a base (generic) resume with information from a specific (targeted) resume. For example, you might override your generic catch-all "software developer" resume with specific details from your targeted "game developer" resume, or combine two partial resumes into a "complete" resume. Merging follows conventional [extend()][9]-style behavior and there's no arbitrary limit to how many resumes you can merge:
```bash ```bash
fluentcmd in1.json in2.json in3.json in4.json -o out.html -o out.doc fluentcv in1.json in2.json in3.json in4.json -o out.html -o out.doc
Reading JSON resume: in1.json Reading JSON resume: in1.json
Reading JSON resume: in2.json Reading JSON resume: in2.json
Reading JSON resume: in3.json Reading JSON resume: in3.json
@ -107,37 +107,37 @@ Generating WORD resume: out.doc
### Multiple targets ### Multiple targets
You can specify **multiple output targets** and FluentCMD will build them: You can specify **multiple output targets** and FluentCV will build them:
```bash ```bash
# Generate out1.doc, out1.pdf, and foo.txt from me.json. # Generate out1.doc, out1.pdf, and foo.txt from me.json.
fluentcmd me.json -o out1.doc -o out1.pdf -o foo.txt fluentcv me.json -o out1.doc -o out1.pdf -o foo.txt
``` ```
You can also omit the output file(s) and/or theme completely: You can also omit the output file(s) and/or theme completely:
```bash ```bash
# Equivalent to "fluentcmd resume.json resume.all -t modern" # Equivalent to "fluentcv resume.json resume.all -t modern"
fluentcmd resume.json fluentcv resume.json
``` ```
### Using .all ### Using .all
The special `.all` extension tells FluentCMD to generate all supported output formats for the given resume. For example, this... The special `.all` extension tells FluentCV to generate all supported output formats for the given resume. For example, this...
```bash ```bash
# Generate all resume formats (HTML, PDF, DOC, TXT, etc.) # Generate all resume formats (HTML, PDF, DOC, TXT, etc.)
fluentcmd me.json -o out/resume.all fluentcv me.json -o out/resume.all
``` ```
..tells FluentCV to read `me.json` and generate `out/resume.md`, `out/resume.doc`, `out/resume.html`, `out/resume.txt`, `out/resume.pdf`, and `out/resume.json`. ..tells FluentCV to read `me.json` and generate `out/resume.md`, `out/resume.doc`, `out/resume.html`, `out/resume.txt`, `out/resume.pdf`, and `out/resume.json`.
### Prettifying ### Prettifying
FluentCMD applies [js-beautify][10]-style HTML prettification by default to HTML-formatted resumes. To disable prettification, the `--nopretty` or `-n` flag can be used: FluentCV applies [js-beautify][10]-style HTML prettification by default to HTML-formatted resumes. To disable prettification, the `--nopretty` or `-n` flag can be used:
```bash ```bash
fluentcmd resume.json out.all --nopretty fluentcv resume.json out.all --nopretty
``` ```
### Silent Mode ### Silent Mode
@ -145,8 +145,8 @@ fluentcmd resume.json out.all --nopretty
Use `-s` or `--silent` to run in silent mode: Use `-s` or `--silent` to run in silent mode:
```bash ```bash
fluentcmd resume.json -o someFile.all -s fluentcv resume.json -o someFile.all -s
fluentcmd resume.json -o someFile.all --silent fluentcv resume.json -o someFile.all --silent
``` ```
## License ## License

0
assets/fluentcmd_ubuntu.png → assets/fluentcv_cli_ubuntu.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 73 KiB

After

Width:  |  Height:  |  Size: 73 KiB

12
package.json
View File

@ -1,10 +1,10 @@
{ {
"name": "fluentcmd", "name": "fluentcv",
"version": "0.6.0", "version": "0.7.0",
"description": "Generate beautiful, targeted resumes from your command line, shell, or in Javascript with Node.js.", "description": "Generate beautiful, targeted resumes from your command line, shell, or in Javascript with Node.js.",
"repository": { "repository": {
"type": "git", "type": "git",
"url": "https://github.com/fluentdesk/fluentcmd.git" "url": "https://github.com/fluentdesk/fluentcv.git"
}, },
"keywords": [ "keywords": [
"resume", "resume",
@ -16,13 +16,13 @@
"license": "MIT", "license": "MIT",
"preferGlobal": "true", "preferGlobal": "true",
"bugs": { "bugs": {
"url": "https://github.com/fluentdesk/fluentcmd/issues" "url": "https://github.com/fluentdesk/fluentcv/issues"
}, },
"main": "src/fluentcmd.js", "main": "src/fluentcmd.js",
"bin": { "bin": {
"fluentcmd": "src/index.js" "fluentcv": "src/index.js"
}, },
"homepage": "https://github.com/fluentdesk/fluentcmd", "homepage": "https://github.com/fluentdesk/fluentcv",
"dependencies": { "dependencies": {
"fluent-themes": "0.1.0-beta", "fluent-themes": "0.1.0-beta",
"fs-extra": "^0.24.0", "fs-extra": "^0.24.0",

2
src/fluentcmd.js
View File

@ -1,5 +1,5 @@
/** /**
Internal resume generation logic for FluentCMD. Internal resume generation logic for FluentCV.
@license Copyright (c) 2015 | James M. Devlin @license Copyright (c) 2015 | James M. Devlin
*/ */

4
src/index.js
View File

@ -1,7 +1,7 @@
#! /usr/bin/env node #! /usr/bin/env node
/** /**
Command-line interface (CLI) for FluentCMD via Node.js. Command-line interface (CLI) for FluentCV via Node.js.
@license Copyright (c) 2015 | James M. Devlin @license Copyright (c) 2015 | James M. Devlin
*/ */
@ -24,7 +24,7 @@ catch( ex ) {
function main() { function main() {
// Setup. // Setup.
var title = '*** FluentCMD v' + PKG.version + ' ***'; var title = '*** FluentCV v' + PKG.version + ' ***';
if( process.argv.length <= 2 ) { logMsg(title); throw { fluenterror: 3 }; } if( process.argv.length <= 2 ) { logMsg(title); throw { fluenterror: 3 }; }
var args = ARGS( process.argv.slice(2) ); var args = ARGS( process.argv.slice(2) );
opts = getOpts( args ); opts = getOpts( args );