davetron5000-daves-resume 0.1.1 → 0.1.2

data/lib/README.rdoc

@@ -4,22 +4,38 @@ This is a set of small tools that allow you to manage your resume as a "database
 
 = Quick Start
 
+    gem sources -a http://gems.github.com
+    sudo gem install davetron5000-daves-resume
     dr-scaffold -r my_resume_dir
     dr-format -r my_resume_dir -f HTML
 
 <tt>resume.html</tt> now contains the resume generated by the scaffold.  To create you resume, you need to:
 
-1. Modify <tt>resume.yaml</tt> with your information
+1. Modify <tt>resume.yaml</tt> with your information (or create multiple for managing resumes of different focus)
 2. Modify <tt>skills.yaml</tt> with your skillset (see below)
 3. Duplicate <tt>experience_Initech.yaml</tt> for each job you've held; this contains all the positions you held at that job, plus other information
 4. Duplicate <tt>education_Degree_Mill_U.yaml</tt> for each degree/education you wish to appear
 5. Duplicate (or delete) <tt>samples_Name_of_this_work_sample.yaml</tt> with any work samples
 
 You can generate in one of three formats:
+
 <tt>RTF</tt>:: - Rich Text which can be read by Word
 <tt>HTML</tt>:: - A basic HTML version
 <tt>Markdown</tt>:: - a Markdown[http://www.daringfireball.com/projects/markdown] version
 
+=Features
+
+==Manage your resume in a format-agnostic database of YAML-based files
+
+Your resume can be version-controlled and edited in the editor of your choice; no more dealing with Word and why the bullet-lists don't work.  Your work experience and other CV-related data are realy data and deserve to be persisted in something more usable than a proprietary Microsoft format.
+
+==Generate your resume as RTF, HTML, or Markdown
+
+Of course, no one is gonna take a resume in YAML (though if they do, you should probably go work there).  As such, you can generate a nice, clean RTF format readable by monster.com, dice.com and HR generalists the world over.
+
+==Manage multiple resumes from the same set of employment/education history
+
+Ever needed to tweak your resume for a particular job?  The second you copy your Word doc and tweak it, you have a version control problem and you now have to fix typos in both documents.  Here, you can create different headlines/summaries for different focusses and you can tag your "Key Achievements" in each position you've held to allow for conditional generation of multiple resumes.  When you change common information, you change it once, the way you would with code.
 
 = YAML format
 
@@ -31,18 +47,25 @@ Basically, the resume is:
 
 Core:: (in <tt>resume.yaml</tt>) - This has stuff like your name, address, summary, etc.  If you wish to have multiple resumes, you will duplicate this file naming it <tt>resume_NAME.yaml</tt> where _NAME_ is the "core name" you can specify on the command-linen to <tt>dr-format</tt>
 Skill Set:: (in <tt>skills.yaml</tt>) - This is a database of your skills, with an experience level and a number of years experience.    These determine the sort order in your resume output.  Basically, skills with which you are an <tt>:expert</tt> are shown first, sorted by years of experience. This is followed by skills where you are <tt>:intermediate</tt>.  <tt>:novice</tt> skills show up in their own category called "Some Experience With".  This allows you to include skills you've used, but be clear where your strengths lie.
+
             * The accepted levels currently are:
+
               <tt>:novice</tt>:: skills show up in "Some Experience With"
               <tt>:intermediate</tt>:: skills show up last in their category
               <tt>:expert</tt>:: skills show up first in their category
+
             * The categories are currently hard-coded (sorry) and any skill not in a category won't show up (this is on my todo list).  The categories are:
+
               <tt>:languages</tt>:: Programming languages, e.g.
               <tt>:apis</tt>:: APIs, standards, etc.
               <tt>:tools</tt>:: Specific technology tools
               <tt>:databases</tt>:: Relational databases
               <tt>:operating_systems</tt>:: Specific operating systems
+
 Experience:: any file that starts with <tt>experience_</tt> and ends in <tt>.yaml</tt> will get picked up.  Things will be sorted properly (in reverse chronological order) for you.  A Job consists of one or more positions, and the formatter should be smart about handling jobs with only one position.
+
              * Acheivements can be tagged and you can use these tags to control your output (see below)
+
 Education:: works like Experience files starting with <tt>education_</tt> will get picked up and sorted reverse chronologically
 Samples:: this is just a name and a link, and only shows up in the Markdown and HTML version (though you are free to modify the RTF version).
 References:: this isn't used anywhere right now, but any file starting with <tt>reference_</tt>  and ending with <tt>.yaml</tt> will get picked up.
@@ -75,7 +98,7 @@ There is a default filter available that might do what you need
 The included filter works as follows:
 
 1. Create a core for the job (e.g. <tt>techlead_resume.yaml</tt>)
-1. Create a config file in your resume dir named <tt>config_techlead.yaml</tt> (e.g.) that looks like so:
+2. Create a config file in your resume dir named <tt>config_techlead.yaml</tt> (e.g.) that looks like so:
     --- !ruby/object:Resume::ResumeConfig 
     achievement_tags: 
     - :lead

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: davetron5000-daves-resume
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - David Copeland