Skip to content
This repository has been archived by the owner on Mar 18, 2022. It is now read-only.

more idiomatic Ubuntu install instructions #8

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

more idiomatic Ubuntu install instructions #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,11 @@ brew install git node llvm@8
npm i -g yarn
```

**Ubuntu 18.04**
**Debian/Ubuntu**

```
apt-get update && apt-get install -y git nodejs npm clang libclang-dev llvm
npm i -g yarn
```
1. `apt install clang libclang-dev llvm`
1. Install Node.js (if it's not already installed): `apt install nodejs npm`
Copy link

@creachadair creachadair Feb 26, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

I'm slightly confused: The PR description says it's not idiomatic to install nodejs and npm via apt, but that's still what we're doing here, right? Did you mean "install yarn via npm" instead?

Separately, a minor nit: I realize markdown processors will render the text with sequential numbers, but part of the point of Markdown is it should be human-readable even in plain text form. I personally dislike the style of using "1." for every bullet, especially when there are only a few. YMMV.

I'd argue the code fence was preferable, because it was copy-pasteable into the terminal. What do you think about something like:

apt install clang libclang-dev llvm
if ! which node ; then apt install nodejs npm ; end

Having a naked pointer to a long page of mixed-system install instructions seems like a regression to me, and if I read it right you may have to click through to at least one additional page (if your Ubuntu is old enough). Maybe we can just inline the hot path here?

curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
sudo apt update && sudo apt install yarn

1. [Install Yarn](https://classic.yarnpkg.com/en/docs/install/#debian-stable)

### Build the C++ compiler plugin and the LSIF conversion tool:

Expand Down