| Age | Commit message (Collapse) | Author |
|---|
|
* Add tabs to getting started page
* Review comments
Co-authored-by: Ryan <fauxpark@gmail.com>
* Align with current theme
* Update docs/newbs_getting_started.md
Co-authored-by: Ryan <fauxpark@gmail.com>
* Apply suggestions from code review
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
|
|
|
|
|
|
|
|
PR #9307 fixed the immediately visible problem (the command that was
added to $HOME/.bashrc was incorrect because of missing quotes around
paths with spaces). However, the modified command is still wrong - it
captures the value of $PATH at the setup time, and the resulting command
written out to $HOME/.bashrc will overwrite $PATH with that captured
value, ignoring any changes in the environment. This may be especially
important for WSL, where the initial value of $PATH in Linux includes
everything which has been added to %PATH% on the Windows side; after
adding that command to $HOME/.bashrc the WSL environment will no longer
pick up any changes made by newly installed Windows software.
Instead of that, use single quotes around the command, so that the
environment variables are not expanded at the setup time, and the
command that is added to $HOME/.bashrc becomes exactly this:
PATH="$HOME/.local/bin:$PATH"
This command will use the $HOME and $PATH environment variable values at
the time the command is executed, not at the time the QMK setup is
performed, so any further updates to $PATH are taken into account.
Double quotes also ensure that the command is safe even if the values of
those environment variables contain spaces.
|
|
* Change `echo` to `export`
* Add `export` as a note under the `echo` command
* Remove note from last commit
Co-authored-by: Ryan <fauxpark@gmail.com>
* Update docs/newbs_getting_started.md
Co-authored-by: Ryan <fauxpark@gmail.com>
* Update docs/newbs_getting_started.md
Add 1 line of whitespace under note
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
|
|
|
|
* CLI: Improve experience when running `qmk setup` on FreeBSD.
* Install the `avrdude` package as well.
* Switch to installing python packages w/ `--user` flag.
* Basic getting started sections for FreeBSD.
* Update `util/freebsd_install.sh` for root/non-root branches.
* Add ID to doc section.
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* Add ID to another docs section.
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* Use `; then` in script for consistency.
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* Updated to use sudo in one shot if available.
* Apply suggestions from code review
Co-authored-by: Erovia <Erovia@users.noreply.github.com>
* Style fixes for latest version in master.
* Apply suggestions from code review
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: skullydazed <skullydazed@users.noreply.github.com>
Co-authored-by: Erovia <Erovia@users.noreply.github.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
|
|
|
|
* Update and try to clarify the CLI installation on Linux
* Update commands, add note for Debian/Ubuntu
* Update docs/newbs_getting_started.md
Co-Authored-By: Joel Challis <git@zvecr.com>
Co-authored-by: Joel Challis <git@zvecr.com>
|
|
Using just qmk setup <github_username> would fail w/ "Could not find repo github.com/<username>, whereas the repo is actually after another slash after the user name. Can consider changing code to add the default forked repo name if slash is not detected in the arg.
|
|
qmk is not available in the official Arch repositories. It is in the AUR, this install command will work if user has `yay` installed.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* Recursively clone qmk_firmware repo
Specifically, so that it grabs the submodules, since ARM keyboards are becoming more common, and we are seeing more issues about chibiOS not being downloaded (in the error log, rather than by question)
* Wrap in shell
|
|
* first pass at configurator docs
* edit existing docs to make reference to QMK Configurator
* contribute my own newb guide to QMK officially from https://github.com/mechmerlin/qmk_setup/blob/master/qmk_configurator.md
* Update docs/newbs_building_firmware_configurator.md
Co-Authored-By: mechmerlin <30334081+mechmerlin@users.noreply.github.com>
* Update docs/newbs_building_firmware_configurator.md
Big red box!
Co-Authored-By: mechmerlin <30334081+mechmerlin@users.noreply.github.com>
* Update docs/newbs_building_firmware_configurator.md
Big red box
Co-Authored-By: mechmerlin <30334081+mechmerlin@users.noreply.github.com>
* Update docs/newbs_building_firmware_configurator.md
Co-Authored-By: mechmerlin <30334081+mechmerlin@users.noreply.github.com>
* Update docs/newbs_building_firmware_configurator.md
Co-Authored-By: mechmerlin <30334081+mechmerlin@users.noreply.github.com>
* Update docs/newbs_building_firmware_configurator.md
Co-Authored-By: mechmerlin <30334081+mechmerlin@users.noreply.github.com>
* Update docs/newbs_building_firmware_configurator.md
Co-Authored-By: mechmerlin <30334081+mechmerlin@users.noreply.github.com>
|
|
guide (#4342)
* Improve wording, punctuation and capitalization in newbs_getting_started guide
Also add some links
* Update example build command output
Co-Authored-By: vomindoraan <vomindoraan@gmail.com>
* Replace occurrences of "layout" with "keymap"
Co-Authored-By: MechMerlin <30334081+mechmerlin@users.noreply.github.com>
* Explicitly instruct users to open an MSYS2 MinGW 64-bit terminal
* MSYS2 Console → MSYS2 MinGW
* Replace thin spaces with regular spaces
|
|
|
|
|
|
|
|
|
|
|
|
|
