-
-
Notifications
You must be signed in to change notification settings - Fork 353
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added instructions for gh-pages deployment (#144)
* Added instructions for gh-pages deployment * changes per @yanfali * Fix for CNAME instruction
- Loading branch information
1 parent
7ff29bc
commit 07ab06b
Showing
2 changed files
with
48 additions
and
2 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
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 |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# How to set up a GitHub instance of the QMK Configurator | ||
|
||
This document will walk you through deploying an instance of the QMK Configurator via your own repository. | ||
|
||
## 1. Fork the qmk/qmk_configurator repository | ||
|
||
Go to [qmk/qmk_configurator](https://github.com/qmk/qmk_configurator), and click the `fork` button at top right. | ||
|
||
## 2. Create a gh-pages branch | ||
|
||
In your git CLI, enter: | ||
|
||
git checkout gh-pages | ||
|
||
This will create a copy of the `gh-pages` branch that is already on the QMK repo. | ||
|
||
## 3. Remove the CNAME file | ||
|
||
Remove the `CNAME` file, which is only for the production version of the Configurator. | ||
|
||
rm CNAME | ||
|
||
## 4. Edit the _config.yml file | ||
|
||
In the root directory, open the `_config.yml` file in a text editor, and edit it as appropriate: | ||
|
||
title: QMK Configurator | ||
email: <github_email> # the email attached to your GitHub account | ||
show_downloads: true | ||
description: QMK for potatoes - an open source configurator for QMK Firmware (only the AVR boards right now) | ||
baseurl: "/qmk_configurator" # DO NOT CHANGE THIS LINE! | ||
# Replace <github_username> on the following three lines with your GitHub username | ||
url: "http://<github_username>.github.io" | ||
github_username: <github_username> | ||
repository: <github_username>/qmk_configurator | ||
theme: jekyll-theme-minimal | ||
|
||
## 5. Deploy your instance | ||
|
||
When you're done editing, save the file, commit it to your branch, and push your changes to your GitHub repo. | ||
|
||
git add . | ||
git commit -m "initial setup" | ||
git push | ||
|
||
Once you've pushed your changes, your instance should be live in about 30 seconds at `https://<github_username>.github.io/qmk_configurator`. |