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

github.com/tylerjlawson/simple-resume.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.md18
1 files changed, 13 insertions, 5 deletions
diff --git a/README.md b/README.md
index 1df2f2a..9228069 100644
--- a/README.md
+++ b/README.md
@@ -1,28 +1,36 @@
# Simple Resume Theme
+
This theme is meant to create a web based, simple resume, that you can print.
![Screenshot](https://raw.githubusercontent.com/tylerjlawson/simple-resume/3495ff7d4351510595820d08a7f3b01733197e75/images/tn.png)
## Features
- - Web based resume
- - Printable
- - Straightforward/simple design
+
+- Web based resume
+- Printable
+- Straightforward/simple design
## Install theme on your hugo site
+
```
hugo new site your-site-name # if you already have a site ignore this line and the next
cd your-site-name
cd themes
git clone https://github.com/tylerjlawson/simple-resume.git
-```
+```
+
Once you have done this, you may use the `exampleSite` folder as an example for how to set your project up. The two main things to pay attention to is to first set this in your `config.toml` file:
+
```toml
theme = "simple-resume"
```
+
Then you will need to replicate the data used in the `exampleSite/data/content.toml` file to fill in the fields for your resume.
## Print your Resume
+
You can print the page straight to a pdf or to paper if you wish. I have had best luck printing with the margins set to 'minimum', but you can set custom margins when printing if it looks off to you.
-## Contributing
+## Contributing
+
Please feel free to post issues or make pull requests at any time. I am always open to collaboration.