hugo-devresume-theme/README.md

132 lines
2.5 KiB
Markdown
Raw Permalink Normal View History

2019-11-03 18:23:33 +00:00
# Hugo DevResume Theme
2019-11-03 18:18:08 +00:00
2019-11-03 18:24:24 +00:00
This is a Hugo port of [DevResume](//github.com/xriley/DevResume-Theme) - a great looking resume/CV template
2019-11-03 18:23:33 +00:00
designed for developers by Xiaoying Riley.
2019-11-03 18:18:08 +00:00
## Screenshot
2019-11-03 18:27:44 +00:00
![DevResume screenshot](https://raw.githubusercontent.com/cowboysmall-tools/hugo-devresume-theme/master/images/screenshot.png)
2019-11-03 18:18:08 +00:00
## Features
### Original
- Fully Responsive
- HTML5 + CSS3
- Built on Bootstrap 4
- 1000+ FontAwesome icons
- SCSS source files included
- Compatible with all modern browsers
### Added
- Google Analytics
## Demo
2019-11-03 18:27:44 +00:00
You can see it in action on [Hugo Themes site](http://themes.gohugo.io/theme/hugo-devresume-theme/).
2019-11-03 18:18:08 +00:00
## Contents
- [Installation](#installation)
- [Getting started](#getting-started)
2019-11-03 18:27:44 +00:00
- [Setup](#setup)
- [Viewing](#viewing)
- [Building](#building)
2019-11-03 18:18:08 +00:00
- [Contributing](#contributing)
- [License](#license)
## Installation
Within the root of your Hugo project execute the following:
$ cd themes
2019-11-03 18:27:44 +00:00
$ git clone https://github.com/cowboysmall-tools/hugo-devresume-theme.git
2019-11-03 18:18:08 +00:00
2019-11-03 18:27:44 +00:00
## Getting Started
2019-11-03 18:18:08 +00:00
After successful installation as a minimum you need to take the following steps:
2019-11-03 18:23:33 +00:00
### Setup
2019-11-03 18:18:08 +00:00
2019-11-03 18:27:44 +00:00
Go to [`exampleSite`](//github.com/cowboysmall-tools/hugo-devresume-theme/tree/master/exampleSite) and copy
[`config.toml`](//github.com/cowboysmall-tools/hugo-devresume-theme/blob/master/exampleSite/config.toml)
2019-11-03 18:23:33 +00:00
to the root of your site. Open `config.toml` and add your relevant information.
2019-11-03 18:18:08 +00:00
2019-11-03 18:23:33 +00:00
### Viewing
2019-11-03 18:18:08 +00:00
To view your site, execute the following:
2019-11-08 02:20:19 +00:00
$ hugo server
2019-11-03 18:18:08 +00:00
and go to `localhost:1313` in your browser.
2019-11-03 18:23:33 +00:00
### Building
2019-11-03 18:18:08 +00:00
2019-11-03 22:33:43 +00:00
To generate your site in the `public` folder, execute the following:
2019-11-03 18:18:08 +00:00
$ hugo
2019-11-03 22:33:43 +00:00
within the root of your project.
2019-11-03 18:18:08 +00:00
## Contributing
2019-11-03 18:27:44 +00:00
Post bugs and contributions to the [issue tracker](//github.com/cowboysmall-tools/hugo-devresume-theme/issues).
Or make a [pull request](//github.com/cowboysmall-tools/hugo-devresume-theme/pulls).
2019-11-03 18:18:08 +00:00
## License
2019-11-03 18:23:33 +00:00
This template is 100% FREE as long as you keep the footer attribution link. You do not have the rights to resell,
sublicense or redistribute (even for free) the template on its own or as a separate attachment from any of your work.
If youd like to use this template without the footer attribution link, you can buy the
[commercial license](https://themes.3rdwavemedia.com/bootstrap-templates/resume/devresume-free-bootstrap-4-resume-cv-template-for-developers/)
2019-11-03 18:18:08 +00:00
You may change the "Ported for..." line by adding the following to the end of `config.toml`
[params.footer]
copyright = ""