From 561677ebbb9689986a8730e3f7ef7197d79a0c91 Mon Sep 17 00:00:00 2001 From: Joel Glovier Date: Thu, 23 Jul 2015 13:55:20 -0400 Subject: [PATCH] update readme to clarify options --- README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9055ffc..8c1d141 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,6 @@ ## Docs -### Customizing - -First you'll want to fork the repo to your own account. Then clone it locally and customize, or use the GitHub web editor to customize. Much Most of the basic customization will take place in the `/_config.yml` file, and most of the content configuration will take place in the `/_layouts/resume.html` file - ### Running locally To test locally, run the following in your terminal: @@ -19,6 +15,20 @@ To test locally, run the following in your terminal: 2. `bundle exec jekyll serve` 3. Open your browser to `localhost:4000` +### Customizing + +First you'll want to fork the repo to your own account. Then clone it locally and customize, or use the GitHub web editor to customize. + +#### Options/configuration + +Much Most of the basic customization will take place in the `/_config.yml` file. Here is a list of customizations available via `/_config.yml`: + +[...write these out...] + +#### Editing content + +Most of the content configuration will take place in the `/_layouts/resume.html` file. Simply edit the markup there accordingly + ### Publishing to GitHub Pages for free [GitHub Pages](https://pages.github.com/) will host this for free with your GitHub account. Just make sure you're using a `gh-pages` branch, and the site will automatically be available at `yourusername.github.io/resume-template` (you can rename the repo to resume for your own use if you want it to be available at `yourusername.github.io/resume`). You can also add a CNAME if you want it to be available at a custom domain...