diff options
| author | Tyler Lawson <tylerjlawson2@gmail.com> | 2020-10-15 05:59:42 +0300 |
|---|---|---|
| committer | Tyler Lawson <tylerjlawson2@gmail.com> | 2020-10-15 05:59:42 +0300 |
| commit | 459f1992dd9c25c9ba477db5f05352b56049aefe (patch) | |
| tree | 249a30235429b5a4d630382a9224f3d161429433 /README.md | |
| parent | 6b46224acad5b480fe4c588d3297680255040b6b (diff) | |
added readme and updated theme description
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..0a4beaa --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# Simple Resume Theme +This theme is meant to create a web based, simple resume, that you can print. + + + +# Features + - 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 +Please feel free to post issues or make pull requests at any time. I am always open to collaboration.
\ No newline at end of file |