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 installaton methods in README.md #643

Closed
wants to merge 2 commits into from
Closed

Update installaton methods in README.md #643

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
11da21e
Update curl install in README.md
marcinjahn Jul 22, 2023
73b1698
Add both simple and more manual installation scripts to README.md
marcinjahn Jul 22, 2023
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
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,14 @@ command not found: node

# Getting Started

The easiest way to install tea is with our installer:

```sh
sh <(curl https://tea.xyz)
Copy link
Member

Choose a reason for hiding this comment

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

I actually deliberately removed this recently to encourage people to install via brew as our suggested workflow.

magic can then be added manually, and I intend to improve that.

there's too much worry regarding curl | sh installers nowadays and it hinders our adoption.

So yeah, please remove.

Copy link
Author

Choose a reason for hiding this comment

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

So, would you like to leave only brew installation instruction in the README? I think it'd limit adoption further as well, especially for Linux folks, I guess brew is not that popular on that platform as it is on mac.

Copy link
Member

@mxcl mxcl Jul 25, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

The instructions also provide a one-liner for installation for people without brew.

so far we've experienced severe reluctance to use our curl installer. So severe I'm just removing it. Use brew or download the standalone tea binary.

It's weird since this method is used for brew installation; and I wrote the brew curl installer. But people are what they are.

Copy link
Member

Choose a reason for hiding this comment

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

edit: and you say the one-liner doesn't work for linux intel so we should fix that. I added a comment below about that.

```

You could also use Homebrew:

```sh
brew install teaxyz/pkgs/tea-cli
```
Expand All @@ -230,8 +238,8 @@ If you prefer, tea is a standalone, cross-platform binary that you can install
anywhere you want ([releases]). Here’s a handy one-liner:

```sh
sudo install -m 755 \
<(curl --compressed -LSsf https://tea.xyz/$(uname)/$(uname -m)) \
sudo install -m 755 \\
Copy link
Member

Choose a reason for hiding this comment

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

whoops and thanks

Copy link
Member

Choose a reason for hiding this comment

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

seems actually these aren't required.

<(curl --compressed -LSsf https://tea.xyz/$(uname)/$(uname -m)) \\
/usr/local/bin/tea
```

Expand Down