Files
pengzhan.dev/README.md
T
Joel Glovier be52819c97 update readme
2015-07-22 23:22:36 -04:00

48 lines
1.1 KiB
Markdown

# resume-template
*A simple Jekyll + GitHub Pages powered resume template.*
## Docs
### Running locally
To test locally, run the following in your terminal:
1. `bundle install`
2. `bundle exec jekyll serve`
3. Open your browser to `localhost:4000`
### Customizing
Most of the basic customization will take place in the `_config.yml` file.
### Publishing to GitHub Pages for free
...write me...
### Configuring with your own domain name
...write me...
### Themes
Right now resume-template only has one theme. More are coming :soon: though. :heart:
## Roadmap
- [ ] Add print button/styles
- [ ] Add PDF button/functionality
- [ ] Add more theme styles
- [ ] Add a "fork me on GitHub" thing
- [ ] Finish docs
- [ ] Cleanup CSS
## Contributing
...write me...
## License
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:
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.