resume: adjust few stuff

anishshobithps · Jan 11, 2025 · a3ebc54 · a3ebc54
1 parent 1cbcbf6
commit a3ebc54
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 41 deletions.
diff --git a/formatting.sty b/formatting.sty
@@ -1,60 +1,59 @@
 % -----------------------------------------------------------------------------
-% Formatting.sty - Custom formatting and commands for a modular resume
+% Formatting.sty - Custom Formatting and Commands for a Modular Resume
 % -----------------------------------------------------------------------------
 % Purpose:
-% This file contains styling and commands for creating a professional resume.
+% This file provides styling and commands for creating a professional resume.
 % It is designed to be modular, allowing easy maintenance and reuse.
 % -----------------------------------------------------------------------------
 
 % -----------------------------------------------------------------------------
 % Required Packages
 % -----------------------------------------------------------------------------
-\RequirePackage[T1]{fontenc}           % T1 font encoding for proper hyphenation
-\RequirePackage[utf8]{inputenc}        % UTF-8 input encoding
-\RequirePackage{enumitem}              % Customization of list environments
-\RequirePackage[hidelinks]{hyperref}   % Hyperlinks without visible borders
-\RequirePackage{titlesec}              % Custom section titles
-\RequirePackage{XCharter}              % Professional font family
-\RequirePackage{xstring}               % String manipulation (e.g., URL processing)
-\RequirePackage{geometry}              % Page layout and margins
-\RequirePackage{etoolbox}              % Enhanced conditional and command tools
-\RequirePackage{fancyhdr}              % Custom headers and footers
+\RequirePackage[T1]{fontenc}             % T1 font encoding for proper hyphenation
+\RequirePackage[utf8]{inputenc}          % UTF-8 input encoding
+\RequirePackage{enumitem}                % Customization of list environments
+\RequirePackage[hidelinks]{hyperref}     % Hyperlinks without visible borders
+\RequirePackage{titlesec}                % Custom section titles formatting
+\RequirePackage{XCharter}                % Professional font family (XCharter)
+\RequirePackage{xstring}                 % String manipulation (e.g., URL processing)
+\RequirePackage{geometry}                % Page layout and margins
+\RequirePackage{fancyhdr}                % Custom headers and footers
+\RequirePackage{etoolbox}                % Enhanced conditional and command tools
 
 % -----------------------------------------------------------------------------
 % Page Layout and Margins
 % -----------------------------------------------------------------------------
-\geometry{a4paper, margin=0.5in}       % A4 paper with 0.5in margins
+\geometry{a4paper, margin=0.5in}         % A4 paper with 0.5in margins
 
 % -----------------------------------------------------------------------------
 % Global Text and Page Settings
 % -----------------------------------------------------------------------------
-\raggedright                          % Left-align text
-\pagestyle{empty}                     % Disable page numbering
-\input{glyphtounicode}                % Enable machine-readable PDF output
-\pdfgentounicode=1
+\raggedright                            % Left-align text
+\pagestyle{empty}                       % Disable page numbering
+\input{glyphtounicode}                  % Enable machine-readable PDF output
+\pdfgentounicode=1                      % Unicode output
 
 % -----------------------------------------------------------------------------
 % Section Title Formatting
 % -----------------------------------------------------------------------------
-\titleformat{\section}
-  {\bfseries\large}{}{0pt}{}[\vspace{1pt}\titlerule\vspace{-6.5pt}]
-% Bold, large section titles with a horizontal line below
+\titleformat{\section}                  % Custom section title format
+  {\bfseries\large}{}{}{}[\vspace{1pt}\titlerule\vspace{-6.5pt}]  % Bold, large section titles with a horizontal line
 
 % -----------------------------------------------------------------------------
 % List Formatting
 % -----------------------------------------------------------------------------
-\renewcommand\labelitemi{$\vcenter{\hbox{\small$\bullet$}}$}
-\setlist[itemize]{
-  itemsep=-2pt,                       % Space between items
-  leftmargin=12pt,                    % Indentation
-  topsep=7pt                          % Space above list
+\renewcommand\labelitemi{$\vcenter{\hbox{\small$\bullet$}}$}  % Custom bullet for itemized lists
+\setlist[itemize]{                      % Customization for itemized lists
+  itemsep=-2pt,                          % Space between items
+  leftmargin=12pt,                       % Indentation
+  topsep=7pt                             % Space above list
 }
 
 % -----------------------------------------------------------------------------
 % Spacing Adjustments
 % -----------------------------------------------------------------------------
-\setlength{\parskip}{0pt}             % No extra space between paragraphs
-\setlength{\parindent}{0pt}           % No paragraph indentation
+\setlength{\parskip}{0pt}               % No extra space between paragraphs
+\setlength{\parindent}{0pt}             % No paragraph indentation
 
 % -----------------------------------------------------------------------------
 % Custom Commands
@@ -70,7 +69,7 @@
   \StrSubstitute{#1}{https://}{}[\Result]%
   \StrSubstitute{\Result}{http://}{}[\Result]%
   \StrSubstitute{\Result}{mailto:}{}[\Result]%
-  \href{#1}{\Result}%
+  \href{#1}{\Result}  % Converts to clickable link with a clean URL display
 }
 
 % Command: Skills List
@@ -105,18 +104,18 @@
 }
 
 % -----------------------------------------------------------------------------
-% Documentation
+% Documentation for Users
 % -----------------------------------------------------------------------------
-% This package provides:
-% - \skills: Create a list of skills with a type and list of skills.
-% - \technologies: List technologies used in a project.
-% - \shorturl: Display a shortened URL without the protocol.
-% - \project: Define a project with name, URL, technologies, and details.
-% - \experience: Add work experience with role, company, time period, location, and responsibilities.
-% - \education: Add education details with degree, institution, URL, and graduation date.
+% This package provides the following commands:
+% - \skills: Creates a list of skills with type and list of skills.
+% - \technologies: Displays technologies used in a project.
+% - \shorturl: Creates a clickable URL with the protocol stripped out.
+% - \project: Defines a project with name, URL, technologies, and details.
+% - \experience: Adds work experience with role, company, time period, location, and responsibilities.
+% - \education: Adds education details with degree, institution, URL, and graduation date.
 
 % -----------------------------------------------------------------------------
 % Notes:
 % - Adjust spacing, margins, and list styles as needed for different templates.
-% - All sections should be imported from separate files for better modularity.
+% - Sections should be imported from separate files for better modularity and reuse.
 % -----------------------------------------------------------------------------
diff --git a/main.tex b/main.tex
@@ -1,13 +1,10 @@
 \documentclass[11pt]{article}
-\usepackage{formatting}  % Include custom formatting commands
+\usepackage{formatting}  % Custom styling and commands for a modular resume
 
 \begin{document}
 
 \input{sections/header}
-
 \vspace{-14pt}
-
-% Resume Sections
 \input{sections/skills}
 \vspace{-14pt}
 \input{sections/projects}