Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update and try to clarify the CLI installation on Linux #8783

Merged
merged 3 commits into from
Apr 27, 2020
Merged

Update and try to clarify the CLI installation on Linux #8783

merged 3 commits into from
Apr 27, 2020

Conversation

Erovia
Copy link
Member

@Erovia Erovia commented Apr 13, 2020 •
edited
Loading

Description

Tested on

  • Fedora 31
  • Ubuntu 16.04
  • Ubuntu 18.04
  • Manjaro
  • Debian 10
  • Debian 9

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Keyboard (addition or update)
  • Keymap/layout/userspace (addition or update)
  • Documentation

Issues Fixed or Closed by This PR

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

@Erovia Erovia requested review from skullydazed, zvecr and a team April 13, 2020 06:59
skullydazed
skullydazed reviewed Apr 13, 2020
View reviewed changes
docs/cli.md Outdated Show resolved Hide resolved
@Erovia Erovia mentioned this pull request Apr 19, 2020
Closed
13 tasks
@Erovia Erovia requested a review from a team April 19, 2020 12:10
@Erovia Erovia mentioned this pull request Apr 19, 2020
Merged
13 tasks
skullydazed
skullydazed reviewed Apr 19, 2020
View reviewed changes
docs/newbs_getting_started.md
Comment on lines +71 to +76
* Arch / Manjaro: `sudo pacman -S git python python-pip python-setuptools libffi`


Install the global CLI to bootstrap your system:

`python3 -m pip install --user qmk` (on Arch-based distros you can also try the `qmk` package from AUR (**note**: it's maintained by a community member): `yay -S qmk`)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm torn on how we handle arch here. It's a better user experience if they simply install qmk from AUR, but this implies that they have to install some things manually first. Also, why does libffi need to be installed manually?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The problem I wanted to solve: we do not control the AUR package, @Curry does, but nobody can expect him to keep up with the releases.
We do have control over the PYPI package.

So I'd rather leave the decision to the users.

libffi: It wasn't pulled in as a dependency for any of the packages and the pip installation fails without it as one of the modules requires it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we could work with @Curry to get direct access and setup a pipeline for releases. It's a direction I'd like to go anyway (for example I plan to auto-update the homebrew update once I figure out how.)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have added libffi to the dependencies, so in-case that package isn't installed, it will be installed with the qmk package.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can see that happening in the (near) future, but for now I'm focusing fixing our current docs, so less user stuck following the getting started guide.

zvecr
zvecr requested changes Apr 24, 2020
View reviewed changes
docs/newbs_getting_started.md Outdated Show resolved Hide resolved
@Erovia Erovia requested a review from zvecr April 26, 2020 15:38
@zvecr zvecr merged commit 2c0deb8 into qmk:master Apr 27, 2020
violet-fish pushed a commit to violet-fish/qmk_firmware that referenced this pull request May 3, 2020
@Erovia @zvecr @violet-fish
Update and try to clarify the CLI installation on Linux (qmk#8783)
a2637a5 
* 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 <[email protected]>

Co-authored-by: Joel Challis <[email protected]>
bitherder pushed a commit to bitherder/qmk_firmware that referenced this pull request May 15, 2020
@Erovia @zvecr @lorenzoernesto
Update and try to clarify the CLI installation on Linux (qmk#8783)
b2b2599 
* 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 <[email protected]>

Co-authored-by: Joel Challis <[email protected]>
sowbug pushed a commit to sowbug/qmk_firmware that referenced this pull request May 24, 2020
@Erovia @zvecr @sowbug
Update and try to clarify the CLI installation on Linux (qmk#8783)
c0fc586 
* 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 <[email protected]>

Co-authored-by: Joel Challis <[email protected]>
turky pushed a commit to turky/qmk_firmware that referenced this pull request Jun 13, 2020
@Erovia @zvecr @turky
Update and try to clarify the CLI installation on Linux (qmk#8783)
f187ff9 
* 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 <[email protected]>

Co-authored-by: Joel Challis <[email protected]>
jakobaa pushed a commit to jakobaa/qmk_firmware that referenced this pull request Jul 7, 2020
@Erovia @zvecr @jakobaa
Update and try to clarify the CLI installation on Linux (qmk#8783)
bd40d8a 
* 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 <[email protected]>

Co-authored-by: Joel Challis <[email protected]>
sjmacneil pushed a commit to sjmacneil/qmk_firmware that referenced this pull request Feb 19, 2021
@Erovia @zvecr @sjmacneil
Update and try to clarify the CLI installation on Linux (qmk#8783)
5c8a5b3 
* 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 <[email protected]>

Co-authored-by: Joel Challis <[email protected]>
BorisTestov pushed a commit to BorisTestov/qmk_firmware that referenced this pull request May 23, 2024
@Erovia @zvecr
Update and try to clarify the CLI installation on Linux (qmk#8783)
7865f69 
* 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 <[email protected]>

Co-authored-by: Joel Challis <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@skullydazed skullydazed skullydazed left review comments

@Curry Curry Curry left review comments

@zvecr zvecr zvecr approved these changes

Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@Erovia @Curry @skullydazed @zvecr