Coder Social home page Coder Social logo

orbit-cv's Introduction

Orbit-CV LaTeX class for Résumés / CVs

1 Overview

This class implements a LaTeX port of the Hugo Orbit theme by Pavel Kanyshev. The implementation was loosely inspired by Carmine Spagnuolo’s TwentySecondsCurriculumVitae class. Unlike TwentySecondsCV, orbit-cv does not impose a one-page limit, and it works as expected with longer résumés / CVs.

I tried to maintain the look and feel of the Orbit theme as much as possible, and the six color schemes implemented by it are available.

2 Usage

2.1 Requirements

This class assumes a more or less current and full LiveTeX installation, and does not require any additional packages if you have one. The typography is based on the the Roboto fonts, so you should install those.

Otherwise, the only thing required is a small-ish picture in a square-ish crop.

2.2 Getting Started

An example résumé is provided along with the class, and can be found in the ./orbit-cv.tex file. Below you will find an explanation of the commands available.

2.2.1 Basic personal data

You should provide at least your name, your job description / title, and a profile picture. This can be done with the same commands as in TwentySecondsCV:

\cvname{Rusty Statue} %your name
\cvjobtitle{Garden Statue}%your actual job position
\profilepic{rusty.png} %path of profile pic

Your contact information can be added with the \addContact macro, which expects two parameters. The first argument is meant to be an icon, and the second one should be some contact information, such as email, website URL, github profile, etc. For example:

\addContact{\faEnvelope{}}{\href{mailto:[email protected]}{[email protected]}}
\addContact{\faPhone{}}{+1234567890}
\addContact{\faGlobe{}}{\href{http://rusty.example.com}{http://rusty.example.com}}

The contact information will be typeset as a table in the sidebar.

You can also add information about your education with the \addEducation macro, which takes three parameters: degree, school, and time period. For example:

\addEducation{PhD. in Hanging Gardening}{Babylon University}{2002—2005}

Language information can be added with the \addLanguage macro, as follows:

\addLanguage{Spanish}{native}
\addLanguage{English}{professional}
\addLanguage{French}{professional}

The first argument in each call should be a language, and the second one a level of proficiency.

If you want to add hobbies or interests, it should be done with the \addInterest macro, which takes a single parameter. For instance:

\addInterest{\faCutlery{} Cooking}
\addInterest{\faCamera{} Photography}

2.2.2 Building the Sidebar

Once you have entered your profile information, you should invoke the \makeprofile macro, which will handle the building of the sidebar.

2.2.3 Main Sections and Helper Macros

You can then proceed to add the main content of your résumé or CV, namely something about your career, experience, projects, etc. The class provides a few macros to help you format those items in a consistent manner. The \workexp macro allows you to add an item of work experience. It takes four parameters, namely a title, a time period, a company name, and a description of the work done / achievements, etc. A usage example could be:

\workexp{Senior Scarecrow}{2017 — present}{The Hanging Garden, Inc.}{
As a Senior Scarecrow at the Hanging Garden, I took care of scaring off all the 
birds and other vermin that came around. I did this so well, that I won
the coveted ``scarecrow of the month'' award.
}

The \project macro takes three paramters: an URL, a project title, and a description. As of this version the URL is not optional, so if one is not available for the project, it could be made to point to the output pdf itself, or some such.

\project{https://www.example.com/blueGarden}{The Blue Garden}{
In the ``Blue Garden'' project, I took care of delivering all the blue fruits and 
seeds, as well as implementing the irrigation plan.
}

If you have publications, you can use the \publication macro, which takes three parameters: a name, an author list, and a venue. For example:

\publication{Fair Gardening}{R. Statue et al.}{IEEE Gardening Letters, vol. 21, no. 1, pp. 184-187. Jan. 2017}

At some point I may implement BibTeX compatibility for this, but for now this will have to do.

2.2.4 Skills

If you want to present skills in an “infographic-like” manner, you can use the \addSkill and \ListSkills macros. The first takes two parameters, a skill name and a skill level, the latter being a number between 0 and 1. Once the desired skills have been added, the \ListSkills macro can be called to render the list of skills (this is done in a tabular environment, so it may have issues if it overlaps a page break).

\addSkill{\LaTeX}{0.95}
\addSkill{Scaring Crows}{0.85}
\addSkill{Gardening}{0.92}
\addSkill{Standing Still}{0.99}
\ListSkills{}

2.2.5 Color Schemes

The orbit-cv class includes six color schemes, like those provided by the Orbit theme. The first scheme is the default, and the others can be accessed via one of the following macros (uncomment as needed)

% Uncomment one of these if you'd rather
% not use the default color scheme

%\colorschemeTwo
%\colorschemeThree
%\colorschemeFour
%\colorschemeFive
%\colorschemeSix

The resulting outputs can be seen below.

./output_samples/colorscheme1.png ./output_samples/colorscheme2.png ./output_samples/colorscheme3.png ./output_samples/colorscheme4.png ./output_samples/colorscheme5.png ./output_samples/colorscheme6.png

3 Longer Samples

You can see an example résumé in the orbit-cv.pdf file, and in the figures below.

./output_samples/page1.png ./output_samples/page2.png ./output_samples/page3.png

orbit-cv's People

Contributors

mvarela avatar

Watchers

James Cloos avatar Alex Crosby avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.