RESME - A Resume Generator
Keep your resume in YAML and output it Org Mode, HTML, and JSON Resume. Org Mode is flexible enough to export to various other formats.
HTML comes with some Europass-inspired CSS, generated by Gemini.
The rendering engine is based on ERB. This simplifies the creation of new output formats (and extending/modifying the YML structure to one’s needs).
Installation
Add this line to your application’s Gemfile:
gem 'resme'
And then execute:
bundle
Or install it yourself as:
gem install resme
Usage
Start with:
resme init
which generates a YML template for your resume in the current directory. Comments in the YML file should help you fill the various entries. Notice that most entries are optional and you can remove sections which are not relevant for your resume.
You can now generate a resume using one of the existing formats:
resme --format org --build resume.yml
If you are not satisfied with the provided templates, you can write your own (see below).
Full syntax:
resme --help
Checking validity
Use the --validate option to verify whether your YAML file conforms with
the intended syntax.
resme --validate resume.yaml
Dates in the resume
Enter dates in the resume in one of the following formats:
- Any format accepted by Ruby for a full date (year, month, day)
- YYYY-MM-DD
- YYYY-MM
- YYYY
The third and the forth format allows you to enter “partial” dates (e.g., when the month or the day have been forgotten or are irrelevant).
Development
After checking out the repo, run bin/setup to install dependencies.
You can also run bin/console for an interactive prompt that will allow
you to experiment.
To install this gem onto your local machine, run
bundle exec rake install. To release a new version, update the version
number in version.rb, and then run bundle exec rake release, which
will create a git tag for the version, push git commits and tags, and
push the .gem file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/avillafiorita/resme.
License
The gem is available as open source under the terms of the MIT License.
Change Log
Bugs
An unknown number of unknown bugs.