-
-
Notifications
You must be signed in to change notification settings - Fork 353
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added instructions for gh-pages deployment #144
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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 branch gh-pages | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this should be |
||
|
||
This will create a copy of the `gh-pages` branch that is already on the QMK repo. | ||
|
||
## 3. Remove the CNAME directory | ||
|
||
Remove the `CNAME` directory, which is only for the production version of the Configurator. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. oops, sorry, I forgot to write something here. It's a file, not a directory. |
||
|
||
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>.qmk.fm" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think it's always There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Hmm, I may have edited this wrongly when I did my initial deployment. I have |
||
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>.qmk.fm/qmk_configurator`. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. s/.qmk.fm/github.io/ and I think you have it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
add 'to github pages' to title