Skip to content

Commit

Permalink
readme index (#2)
Browse files Browse the repository at this point in the history
add index with anchor links
  • Loading branch information
mrtysn authored May 27, 2024
1 parent 70c7ae2 commit 5e49682
Showing 1 changed file with 30 additions and 5 deletions.
35 changes: 30 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,26 @@

A minimalistic CV / Resume template for academic and professional use, designed with React and Semantic UI by Mert Yaşin

##

### 🔗 GitHub Pages Demo

- Visit [mrtysn.github.io/cv](https://mrtysn.github.io/cv/)
Visit [mrtysn.github.io/cv](https://mrtysn.github.io/cv/)

[![CV Preview](cv-preview.gif)](https://mrtysn.github.io/cv/)

##

### Documentation

- [💻 How to Run Locally](#run)
- [🛠️ How to Deploy to GitHub Pages](#deploy)
- [🖨️ How to Save as a PDF](#save)
- [🎨 How to Customize the CV for yourself](#customize)
- [🐌 Does a CV Need to be a Bloated Web Application?](#why)
- [🙌 How to Contribute](#contribute)

[![CV Preview](cv-preview.gif)](https://mrtysn.github.io/cv/)
## <a name="run"></a>

### 💻 How to Run Locally

Expand All @@ -16,6 +31,8 @@ On the root folder of the project, run:
- `pnpm run start`
- Visit [localhost:3000](http://localhost:3000)

## <a name="deploy"></a>

### 🛠️ How to Deploy to GitHub Pages

Make sure your GitHub repository is properly configured for GitHub Pages:
Expand All @@ -32,7 +49,9 @@ On the root folder of the project, run:
- `pnpm run deploy`
- Visit [{your-username}.github.io/cv](https://mrtysn.github.io/cv/)

### 🖨️ How to Create a PDF
## <a name="save"></a>

### 🖨️ How to Save as a PDF

- 👨‍💻 If you are working locally on your computer

Expand All @@ -51,7 +70,9 @@ On the root folder of the project, run:
- 💾 Set the `destination` to `Save as PDF`, and save
- 📤 Remember to properly _rename the document_ before sending it out!

### 🎨 How to Customize the CV for _yourself_
## <a name="customize"></a>

### 🎨 How to Customize the CV for yourself

- ⤴️ Fork the repository to your own account.

Expand Down Expand Up @@ -89,7 +110,9 @@ On the root folder of the project, run:
- Check the `constants.js` file if you are using the `Footer` component, to properly date and version your CV. Remember this will be an always-updating document throughout your career and it's very useful to keep everything in check.
- _Tip:_ You can maintain multiple versions of your CV for different job titles through separate git branches. Versioning also helps keep track of your applications since you would know which variant you applied with.

### ❔ Does a CV Need to be a Bloated Web Application?
## <a name="why"></a>

### 🐌 Does a CV Need to be a Bloated Web Application?

No, it doesn't. What could be a simple document is transformed into a much larger package with this project. However, after finalizing your resume, there are ways to minimize the end result:

Expand All @@ -98,6 +121,8 @@ No, it doesn't. What could be a simple document is transformed into a much large

For individuals versed in web development, this serves as an intuitive method to efficiently generate, update, and distribute a CV.

## <a name="contribute"></a>

### 🙌 How to Contribute

First of all, how kind of you 🤗
Expand Down

0 comments on commit 5e49682

Please sign in to comment.