|
1 | | -# erbb4.github.io |
| 1 | +# resume-template |
| 2 | + |
| 3 | +*A simple Jekyll + GitHub Pages powered resume template.* |
| 4 | + |
| 5 | + |
| 6 | + |
| 7 | +## Docs |
| 8 | + |
| 9 | +### Running locally |
| 10 | + |
| 11 | +To test locally, run the following in your terminal: |
| 12 | + |
| 13 | +1. Clone repo locally |
| 14 | +1. `bundle install` |
| 15 | +2. `bundle exec jekyll serve` |
| 16 | +3. Open your browser to `localhost:4000` |
| 17 | + |
| 18 | +### Customizing |
| 19 | + |
| 20 | +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. |
| 21 | + |
| 22 | +#### Options/configuration |
| 23 | + |
| 24 | +Most of the basic customization will take place in the `/_config.yml` file. Here is a list of customizations available via `/_config.yml`: |
| 25 | + |
| 26 | +[...write these out...] |
| 27 | + |
| 28 | +#### Editing content |
| 29 | + |
| 30 | +Most of the content configuration will take place in the `/_layouts/resume.html` file. Simply edit the markup there accordingly |
| 31 | + |
| 32 | +### Publishing to GitHub Pages for free |
| 33 | + |
| 34 | +[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... |
| 35 | + |
| 36 | +### Configuring with your own domain name |
| 37 | + |
| 38 | +To setup your GH Pages site with a custom domain, [follow the instructions](https://help.github.com/articles/setting-up-a-custom-domain-with-github-pages/) on the GitHub Help site for that topic. |
| 39 | + |
| 40 | +### Themes |
| 41 | + |
| 42 | +Right now resume-template only has one theme. More are coming :soon: though. :heart: |
| 43 | + |
| 44 | +## Roadmap |
| 45 | + |
| 46 | +- [ ] Add print button/styles |
| 47 | +- [ ] Add PDF button/functionality |
| 48 | +- [ ] Add more theme styles |
| 49 | +- [ ] Add a "fork me on GitHub" thing |
| 50 | +- [ ] Finish docs |
| 51 | +- [ ] Cleanup CSS |
| 52 | + |
| 53 | +## Contributing |
| 54 | + |
| 55 | +If you spot a bug, or want to improve the code, or even make the dummy content better, you can do the following: |
| 56 | + |
| 57 | +1. [Open an issue](https://github.com/jglovier/resume-template/issues/new) describing the bug or feature idea |
| 58 | +2. Fork the project, make changes, and submit a pull request |
| 59 | + |
| 60 | +## License |
| 61 | + |
| 62 | +The code and styles are licensed under the MIT license. [See project license.](LICENSE) Obviously you should not use the content of this demo repo in your own resume. :wink: |
| 63 | + |
| 64 | +Disclaimer: Use of Homer J. Simpson image and name used under [Fair Use](https://en.wikipedia.org/wiki/Fair_use) for educational purposes. Project license does not apply to use of this material. |
0 commit comments