Update README

This commit is contained in:
mertbakir 2021-02-13 12:30:54 +03:00 committed by mertbakir
parent caadf1948f
commit 40b9aeb26c
5 changed files with 6 additions and 11 deletions

View file

@ -1,15 +1,10 @@
# To Do: # To Do:
1. ~~Write proper README.~~ 1. Papers Section
2. ~~Projects Section~~ 2. Remove side grid from front config file. [?] > Add new scss and an if statement in head. Should be easy, but I'm not sure if ```/resources``` dependency of theme will be a problem.
3. Papers Section 3. [Here is the blog post](https://mertbakir.gitlab.io/projects/resume-a4/)
4. Remove side grid from front config file. > Add new scss and an if statement in head. Should be ez, but I'm not sure if ```/resources``` dependency of theme would be a problem.
5. ~~Make footer configurable from config file.~~
6. ~~Add multilanguage option.~~ Titles are configurable now.
7. ~~I'll write a blog post soon.~~ [Here is the blog post](https://mertbakir.gitlab.io/projects/resume-a4/)
8. ~~Add linkedin in resume header~~
> I'm open to suggestions or contributions. > _I'm open to suggestions and contributions._
# Features # Features
@ -17,6 +12,7 @@
* Print friendly, just use your browser or save as PDF. * Print friendly, just use your browser or save as PDF.
* Write your resume in yaml. All content stored in data files. * Write your resume in yaml. All content stored in data files.
* Configure sections from ```config.toml```. * Configure sections from ```config.toml```.
* Section names are configurable in ```config.toml```. So, you can write in any language you want.
# How To Use # How To Use
@ -42,7 +38,6 @@ $ git clone https://gitlab.com/mertbakir/resume-a4.git
* Enable/Disable Sections in ```config.toml``` * Enable/Disable Sections in ```config.toml```
* Set avatar link in ```config.toml```, keep your image under ```static``` folder if you want. * Set avatar link in ```config.toml```, keep your image under ```static``` folder if you want.
* Save your resume as pdf, put it under ```static``` folder in root directory. Name the pdf as ```resume.pdf``` or set it's name to ```download``` param in ```config.yml```.
# License # License
@ -52,6 +47,6 @@ This project is open-sourced and licensed under the terms of the MIT license. I
1. Make changes. 1. Make changes.
2. Delete resources folder in main project. 2. Delete resources folder in main project.
2. Build your hugo site using this themes ```hugo server``` (set baseurl = "/" before the build.) 2. Build your hugo site using the theme. ```hugo server```
3. Copy "resources" folder from main project to theme folder ```themes\resume-A4\resources``` 3. Copy "resources" folder from main project to theme folder ```themes\resume-A4\resources```
4. git commit & push. 4. git commit & push.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 240 KiB

BIN
images/one_page_resume.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 102 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 139 KiB

After

Width:  |  Height:  |  Size: 200 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 243 KiB

After

Width:  |  Height:  |  Size: 74 KiB