0
0
mirror of https://github.com/qmk/qmk_firmware.git synced 2024-12-14 13:50:46 +00:00
Commit Graph

44 Commits

Author SHA1 Message Date
Julius Degesys
12de0297ed
Suggest qmk list-keyboards when testing build environment ()
Co-authored-by: Joel Challis <git@zvecr.com>
2023-04-03 15:42:14 +10:00
Sophie Machen
99a39a1198
Update newbs_getting_started to include instructions for apple silicon ()
Co-authored-by: Joel Challis <git@zvecr.com>
2023-03-14 12:58:08 -04:00
Joel Challis
8fa7b62011
Attempt to discourage manual MSYS install for new users () 2022-07-04 00:41:00 +01:00
Ryan
25033d5d9e
MSYS2 install: use MinGW python-qmk package ()
* MSYS2 install: use MinGW python-qmk package

* Add missing flashers

* Note VC Redist for manual install

* VC Redist no longer needed
2022-07-02 15:08:05 +01:00
Joel Challis
40e33d03a8
Recommend pillow as part of manual MSYS install () 2022-05-17 21:50:48 +01:00
Jake VanderVaate
96b6ddf4bf
fixed typo in docs/newbs_getting_started.md () 2022-03-03 09:53:40 +00:00
Albert Y
362a65510a
[Docs] Move QMK newbs build environment guide to next section ()
Co-authored-by: Dasky <32983009+daskygit@users.noreply.github.com>
2022-01-13 02:29:13 +00:00
Albert Y
9b912416b4
[Docs] Add instructions to create keymap before proceeding ()
Co-authored-by: filterpaper <filterpaper@localhost>
2021-10-27 08:03:00 -07:00
Mateusz Piotrowski
189e0d5b98
Update FreeBSD install method ()
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/
2021-05-07 19:22:05 +02:00
Hawley Waldman
98939868fa
Update github instruction link in newbs_getting_started.md ()
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.
2021-04-11 12:45:30 +02:00
Matt Snell
aa2b4a688b
[docs] Add IO Warning to WSL section of Getting Started ()
* 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>
2021-03-26 13:21:21 +11:00
glanchow
162842f16e
[Docs] add qmk setup home parameter () 2021-01-28 04:39:58 +11:00
Joel Challis
4e8166750b
Small tweaks to docs to make them more user friendly ()
* 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>
2021-01-20 18:46:01 +00:00
Toban Wiebe
95a1496ebc
Fix AUR package name ()
On Arch, `qmk` is now in the official repos, whereas only `qmk-git` is in AUR.
2021-01-09 11:37:42 +11:00
Joel Challis
6d9b4c7b4f
Suggest 'QMK MSYS' as the default windows platform ()
* Suggest 'QMK MSYS' as the default windows platform

* Review comments
2021-01-08 11:09:28 -08:00
Reibl János Dániel
6f6e28b4c7
Add Arch / Manjaro section for Linux setup instructions () 2020-12-30 15:02:24 +01:00
Joel Challis
bbf0f65284
Simplify the visual flow of the getting started page ()
* 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>
2020-12-27 16:56:10 +00:00
Boris Faure
9136c122f8
docs: add Gentoo to newbs_getting_started.md () 2020-12-23 17:59:57 +01:00
Ryan
c21d5a0973
Refactor qmk_install.sh () 2020-11-26 14:37:54 +00:00
Ryan
32340e14fb
Update newbs MSYS2 pacman instructions () 2020-06-21 10:54:53 +01:00
Sergey Vlasov
0cb4da2c74
Really fix Ubuntu/Debian setup when $PATH contains spaces ()
PR  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.
2020-06-11 12:26:10 +01:00
neon4272
97ddc7ea18
Fix Ubuntu/Debian setup when $PATH contains 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>
2020-06-10 23:46:13 +01:00
Ryan
e4823aadec
Fix capitalisation of "GitHub" () 2020-05-25 19:43:14 -07:00
Pete Johanson
3ad2be52a7
CLI: Improve experience when running qmk setup on FreeBSD. ()
* 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>
2020-05-20 08:09:13 -07:00
skullY
fcf150bd82 Streamline the macos install process 2020-05-18 22:46:33 -07:00
Erovia
2c0deb8a13
Update and try to clarify the CLI installation on Linux ()
* 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>
2020-04-27 20:29:31 +01:00
mimkorn
3cea9fedff
Add missing repository name to qmk setup w/ github ()
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.
2020-04-14 21:03:13 +10:00
Bram de Wilde
2c201ab9ad Update newbs_getting_started.md
qmk is not available in the official Arch repositories. It is in the AUR, this install command will work if user has `yay` installed.
2020-03-31 14:26:19 -07:00
fauxpark
11f12d386b Fix wrong python-pip package for MSYS setup instructions 2020-03-26 07:50:22 -07:00
Ryan
0d189582c1
Update newbs installation procedure for MSYS2 () 2020-03-21 19:00:44 +11:00
skullY
54c58ea6de Add explicit id tags to externally linked headers 2020-03-05 16:00:10 -08:00
skullY
8249a288d7 fix numbering 2020-03-05 16:00:10 -08:00
skullY
45e218ceec overhaul the newbs guide 2020-03-05 16:00:10 -08:00
skullY
a701c15d87 Rework the newbs guide around the qmk cli 2020-03-05 16:00:10 -08:00
skullY
5b14456082 more wip 2020-03-05 16:00:10 -08:00
Drashna Jaelre
161d469f2c [Docs] Recursively clone qmk_firmware repo ()
* 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
2019-03-18 14:22:33 -07:00
MechMerlin
efe360464d Contribute the MechMerlin QMK Configurator docs ()
* 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>
2019-01-28 17:31:33 -08:00
Konstantin Đorđević
3dec80b774 Improve wording, punctuation and capitalization in newbs_getting_started guide ()
* 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
2018-11-06 12:21:44 -08:00
GreenShadowMaker
06b3637266 added some helpful notes to the documentation () 2018-05-22 12:48:33 -07:00
skullY
ccc87421e7 Some more tweaks to make everything look nice 2018-05-07 23:42:41 -07:00
skullY
303f425c6b Fix up info boxes. 2018-05-07 22:46:26 -07:00
skullY
48e11240a6 Move the linux tutorials to an info box on newbs_getting_started 2018-03-06 20:51:26 -08:00
skullY
6a4e08938e Flesh out the newbs guide 2018-03-06 15:22:47 -08:00
skullydazed
08e48eb6f5
Add a newbie guide for people completely new to QMK () 2018-03-06 14:37:48 -08:00