Skip to content

Commit

Permalink
Added instructions for gh-pages deployment (#144)
Browse files Browse the repository at this point in the history
* Added instructions for gh-pages deployment
* changes per @yanfali
* Fix for CNAME instruction
  • Loading branch information
noroadsleft authored and yanfali committed Jun 13, 2018
1 parent 7ff29bc commit 07ab06b
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ The QMK Configurator allows simple keymap creation and saving via .json keymap f
This project is very much a work in progress. To begin contributing, please refer to the following:

[Issues](https://github.com/qmk/qmk_configurator/issues)
[Development Environment Setup](https://github.com/qmk/qmk_configurator/blob/master/assets/js/development.md)

[Development Environment Setup](https://github.com/qmk/qmk_configurator/blob/master/assets/js/development.md)
[Deploying an instance of the Configurator to GitHub Pages](https://github.com/qmk/qmk_configurator/blob/master/assets/js/gh-pages_setup.md)
46 changes: 46 additions & 0 deletions assets/js/gh-pages_setup.md
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`.

0 comments on commit 07ab06b

Please sign in to comment.