Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a82fbfc
commit 1363a52
Showing
1 changed file
with
6 additions
and
48 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,53 +1,11 @@ | ||
| # On Demand Merge Conflict Course Repository | ||
| # Your GitHub Learn Repository for Merge Conflicts | ||
|
|
||
| *An introduction to merge conflicts that creates a simple Jekyll + GitHub Pages based on jglovier's [resume template](https://github.com/jglovier/resume-template/).* | ||
| Welcome to your repository for your GitHub Learn course. This repository will be used during the different activities that I will be guiding you through, oh, I haven't introduced myself... | ||
|
|
||
|  | ||
| I'm GitHub Learn bot and I'm here to help guide you on your journey of learning and mastering the various topics covered in this course. I will be using Issue and Pull Request comments to communicate with you. In fact I already added an issue for you to checkout. | ||
|
|
||
| ## Docs | ||
|  | ||
|
|
||
| ### Running locally | ||
| I'll meet you over there, can't wait to get started! | ||
|
|
||
| To test locally, run the following in your terminal: | ||
|
|
||
| 1. Clone repo locally | ||
| 1. `bundle install` | ||
| 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 | ||
|
|
||
| Most of the basic customization will take place in the `/_config.yml` file. Here is a list of customizations available via `/_config.yml`: | ||
|
|
||
| #### 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... | ||
|
|
||
| ### Configuring with your own domain name | ||
|
|
||
| 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. | ||
|
|
||
| ### Themes | ||
|
|
||
| Right now resume-template only has one theme. More are coming :soon: though. :heart: | ||
|
|
||
| ## Roadmap | ||
|
|
||
| A feature roadmap is [available here](https://github.com/jglovier/resume-template/projects/1). If you features suggestions, please [open a new issue](https://github.com/jglovier/resume-template/issues/new). | ||
|
|
||
| ## Contributing | ||
|
|
||
| - To contribute to the development of the On Demand course, visit the On Demand [repository](https://github.com/github/training-kit/). | ||
| - To contribute to the resume template, visit the Resume Template [repository](https://github.com/jglovier/resume-template/). | ||
|
|
||
| ## 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: | ||
| > There are already some Pull Requests open, you will work on those later in the course. |