-
Notifications
You must be signed in to change notification settings - Fork 5.9k
docs(contrib): update linux requirements #4328
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
Conversation
Codecov Report
@@ Coverage Diff @@
## main #4328 +/- ##
=======================================
Coverage 66.29% 66.29%
=======================================
Files 31 31
Lines 1620 1620
Branches 316 316
=======================================
Hits 1074 1074
Misses 468 468
Partials 78 78 Continue to review full report at Codecov.
|
✨ Coder.com for PR #4328 deployed! It will be updated on every commit.
|
If you're developing code-server on Linux, make sure you have installed or install the following dependencies: | ||
|
||
```shell | ||
sudo apt-get install build-essential g++ libx11-dev libxkbfile-dev libsecret-1-dev python-is-python3 |
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.
Does this also install pkg-config
? Maybe g++
installs it but I am not sure.
One thing we might want to think about is that the requirements for building from source are the same as the npm requirements so I wonder if there is some clever way to avoid duplication https://github.com/cdr/code-server/blob/main/docs/npm.md#ubuntu-debian
Otherwise we will probably end up only updating one or the other and they get out of sync.
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.
If we need pkg-config, it never hurts to be explicit about it - it won't cause any harm, and package dependencies are an implementation detail that are subject to change
9f09512
to
72e72a0
Compare
72e72a0
to
66a2a16
Compare
This PR updates the
CONTRIBUTING.md
, specifically adding a section for Linux-related dependencies needed to develop code-server.H/T to @bryphe-coder and @vapurrmaid for testing this out on Ubuntu-based dev environments and helping us improve the docs!
Fixes N/A