diff --git a/README.md b/README.md index e31ac3c..6157a6e 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,40 @@ ### πŸ“ CV -- CV of Mert Yaşin as a single page React application - -[![CV Preview](cv-preview.gif)](https://mrtysn.github.io/cv/) +- A CV template from Mert Yaşin designed from scratch using Semantic UI and React ### πŸ”— Online Demo - Visit [mrtysn.github.io/cv](https://mrtysn.github.io/cv/) -### πŸ–¨οΈ How to create a PDF locally - -- Start the project in development mode with `yarn start` - -- Go to http://localhost:3000 on Google Chrome - -- Remove the margins at the top and the bottom of the page manually (i.e. delete divider elements) + [![CV Preview](cv-preview.gif)](https://mrtysn.github.io/cv/) -- Open the print dialog +### πŸ’» How to run locally -- Set A4 as the page size +On the root folder of the project, run -- Enable "background graphics" - -- Save as PDF +- `pnpm run start` ### πŸ› οΈ How to deploy to GitHub Pages - +On the root folder of the project, run + - `pnpm run predeploy` - `pnpm run deploy` -### πŸ–¨οΈ How to create a PDF online - -- Visit [mrtysn.github.io/cv](https://mrtysn.github.io/cv/) on Google Chrome +### πŸ–¨οΈ How to create a PDF -- Remove the margins at the top and the bottom of the page manually (i.e. delete divider elements) +- πŸ‘¨β€πŸ’» If you are working on a local copy -- Open the print dialog + - Run `pnpm run start` + - Visit [localhost:3000](http://localhost:3000) (where the app is running) -- Set A4 as the page size +- 🌐 If you already deployed -- Enable "background graphics" + - Visit [mrtysn.github.io/cv](https://mrtysn.github.io/cv/) (where you deployed it) -- Save as PDF +- Open the print dialog by hitting `ctrl + P` + - Set margins to custom. Set the top padding to `0.19 inches` inches and the rest to `0 inches`. This is (unfortunately) necessary to get the text to align properly while dealing with CSS and the browser print dialog + - πŸ“ƒ Set `A4` as the page size + - 🎨 Enable `background graphics` so you get that nice accent color + - πŸ–¨οΈ Save as PDF + - πŸ“€ Remember to properly _rename the document_ before sending it out!