Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/mertbakir/resume-a4.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 6 insertions, 9 deletions
diff --git a/README.md b/README.md
index 515c8b2..3796797 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,11 @@
-# To Do:
-
-1. Papers 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. [Here is the blog post](https://mertbakir.gitlab.io/projects/resume-a4/)
-
-> _I'm open to suggestions and contributions._
-
# Features
* Simple, easy to use, single page, A4-sized Resume generator.
* Print friendly, just use your browser or save as PDF.
* Write your resume in yaml. All content stored in data files.
-* Configure sections from ```config.toml```.
+* Enable/Disable sections from ```config.toml```.
* Section names are configurable in ```config.toml```. So, you can write in any language you want.
+* Change ```bib_style``` (APA, IEEE, else) for ```publications.yaml```.
# How To Use
@@ -38,11 +31,15 @@ $ git clone https://gitlab.com/mertbakir/resume-a4.git
* Enable/Disable Sections in ```config.toml```
* Set avatar link in ```config.toml```, keep your image under ```static``` folder if you want.
+* You can change bib_style in the config file. I've created options for APA and IEEE standards. You can configure ```publications.html``` file in the ```layouts\partials``` folder if you are looking for something else.
+* [Here is the blog post](https://mertbakir.gitlab.io/projects/resume-a4/) about this project.
# License
This project is open-sourced and licensed under the terms of the MIT license. I would be happy though, if you give attribution. <3
+> _I'm open to suggestions and contributions._
+
# My Work Flow
1. Make changes.