summaryrefslogtreecommitdiff
path: root/docs/newbs_getting_started.md
Commit message (Collapse)AuthorAge
* Attempt to discourage manual MSYS install for new users (#17556)Joel Challis2022-07-04
|
* MSYS2 install: use MinGW python-qmk package (#17302)Ryan2022-07-02
| | | | | | | | | * MSYS2 install: use MinGW python-qmk package * Add missing flashers * Note VC Redist for manual install * VC Redist no longer needed
* Recommend pillow as part of manual MSYS install (#17133)Joel Challis2022-05-17
|
* fixed typo in docs/newbs_getting_started.md (#16501)Jake VanderVaate2022-03-03
|
* [Docs] Move QMK newbs build environment guide to next section (#15386)Albert Y2022-01-13
| | | Co-authored-by: Dasky <32983009+daskygit@users.noreply.github.com>
* [Docs] Add instructions to create keymap before proceeding (#14945)Albert Y2021-10-27
| | | Co-authored-by: filterpaper <filterpaper@localhost>
* Update FreeBSD install method (#12815)Mateusz Piotrowski2021-05-07
| | | | | | | | The easiest way to install QMK CLI and all the necessary dependencies on FreeBSD is to use the packages from the official FreeBSD Ports Collection. This is possible since QMK CLI has been added to the Ports Collection: https://www.freshports.org/sysutils/py-qmk/
* Update github instruction link in newbs_getting_started.md (#12510)Hawley Waldman2021-04-11
| | | Clarify that the link to the github/forking instructions is a link to how to fork this project. Previous wording implied that the link was to a how-to-use github in general page.
* [docs] Add IO Warning to WSL section of Getting Started (#12384)Matt Snell2021-03-26
| | | | | | | | | * Add IO Warning to WSL section of Getting Started * FauxPark suggestion (thanks!) Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
* [Docs] add qmk setup home parameter (#11451)glanchow2021-01-28
|
* Small tweaks to docs to make them more user friendly (#11518)Joel Challis2021-01-20
| | | | | | | | | | | | | | | * first pass * firmware firmware? * Split out debug + testing docs * tidy up duplicate css * Add extra info to debug example Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Drashna Jaelre <drashna@live.com>
* Fix AUR package name (#11416)Toban Wiebe2021-01-09
| | | On Arch, `qmk` is now in the official repos, whereas only `qmk-git` is in AUR.
* Suggest 'QMK MSYS' as the default windows platform (#11321)Joel Challis2021-01-08
| | | | | * Suggest 'QMK MSYS' as the default windows platform * Review comments
* Add Arch / Manjaro section for Linux setup instructions (#10509)Reibl János Dániel2020-12-30
|
* Simplify the visual flow of the getting started page (#11316)Joel Challis2020-12-27
| | | | | | | | | | | | | | | | | | | * 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>
* docs: add Gentoo to newbs_getting_started.md (#11241)Boris Faure2020-12-23
|
* Refactor qmk_install.sh (#10681)Ryan2020-11-26
|
* Update newbs MSYS2 pacman instructions (#9445)Ryan2020-06-21
|
* Really fix Ubuntu/Debian setup when $PATH contains spaces (#9370)Sergey Vlasov2020-06-11
| | | | | | | | | | | | | | | | | | | | | | | | 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.
* Fix Ubuntu/Debian setup when $PATH contains spaces (#9307)neon42722020-06-10
| | | | | | | | | | | | | | | | | | | | | * 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>
* Fix capitalisation of "GitHub" (#9184)Ryan2020-05-25
|
* CLI: Improve experience when running `qmk setup` on FreeBSD. (#8798)Pete Johanson2020-05-20
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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>
* Streamline the macos install processskullY2020-05-18
|
* Update and try to clarify the CLI installation on Linux (#8783)Erovia2020-04-27
| | | | | | | | | | | * 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>
* Add missing repository name to qmk setup w/ github (#8792)mimkorn2020-04-14
| | | 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.
* Update newbs_getting_started.mdBram de Wilde2020-03-31
| | | qmk is not available in the official Arch repositories. It is in the AUR, this install command will work if user has `yay` installed.
* Fix wrong python-pip package for MSYS setup instructionsfauxpark2020-03-26
|
* Update newbs installation procedure for MSYS2 (#8423)Ryan2020-03-21
|
* Add explicit id tags to externally linked headersskullY2020-03-05
|
* fix numberingskullY2020-03-05
|
* overhaul the newbs guideskullY2020-03-05
|
* Rework the newbs guide around the qmk cliskullY2020-03-05
|
* more wipskullY2020-03-05
|
* [Docs] Recursively clone qmk_firmware repo (#5378)Drashna Jaelre2019-03-18
| | | | | | | | * 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
* Contribute the MechMerlin QMK Configurator docs (#4986)MechMerlin2019-01-28
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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>
* Improve wording, punctuation and capitalization in newbs_getting_started ↵Konstantin Đorđević2018-11-06
| | | | | | | | | | | | | | | | | | | | | | 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
* added some helpful notes to the documentation (#2981)GreenShadowMaker2018-05-22
|
* Some more tweaks to make everything look niceskullY2018-05-07
|
* Fix up info boxes.skullY2018-05-07
|
* Move the linux tutorials to an info box on newbs_getting_startedskullY2018-03-06
|
* Flesh out the newbs guideskullY2018-03-06
|
* Add a newbie guide for people completely new to QMK (#2480)skullydazed2018-03-06
generated by cgit v1.2.3 (git 2.39.1) at 2024-06-29 03:56:51 +0000