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.

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

Update installaton methods in README.md #643

Closed
wants to merge 2 commits into from

Conversation

marcinjahn
Copy link

The previous command did not work on a typical x86 Linux system. The link generated by the script - https://tea.xyz/Linux/x86_64 - was invalid. The updated command is taken directly from https://docs.tea.xyz/getting-started/install-tea

The previous command did not work on a typical x86 Linux system. The link generated by the script - https://tea.xyz/Linux/x86_64 - was invalid. The updated command is taken directly from https://docs.tea.xyz/getting-started/install-tea
@what-the-diff
Copy link

what-the-diff bot commented Jul 22, 2023

PR Summary

  • README.md Update
    The README.md file has been updated with a new section that includes comprehensive instructions on two different methods of installing 'tea'. These methods include utilizing the installer or using the Homebrew software package management system.

  • Simplified Install Process
    A one-liner command has been added to streamline the installation process. This concise command allows users to install the 'tea' binary efficiently, simplifying the overall installation process.

@marcinjahn
Copy link
Author

Reading the docs, I realized that you actually want to support both the script I removed in the PR, and the one I added. Then, the proper modification would be to:

  • make the script I deleted work
  • add the simple installation script that I added to readme

@marcinjahn marcinjahn changed the title Update curl install in README.md Update installaton methods in README.md Jul 22, 2023
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

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.

@@ -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.

@mxcl
Copy link
Member

mxcl commented Jul 25, 2023

The previous command did not work on a typical x86 Linux system. The link generated by the script - https://tea.xyz/Linux/x86_64 - was invalid

@jhheider what we got and what do we need to fix this?

@jhheider
Copy link
Contributor

$ curl -OL https://tea.xyz/Linux/x86_64
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   103  100   103    0     0    239      0 --:--:-- --:--:-- --:--:--   241
100 98.1M  100 98.1M    0     0  25.2M      0  0:00:03  0:00:03 --:--:-- 32.4M
$ file x86_64
x86_64: ELF 64-bit LSB pie executable, x86-64, version 1 (SYSV), dynamically linked, interpreter /lib64/ld-linux-x86-64.so.2, for GNU/Linux 3.2.0, with debug_info, not stripped

That looks right to me. @marcinjahn did you use curl? It only returns anything for curl, and is 404 otherwise.

@marcinjahn
Copy link
Author

curl -OL https://tea.xyz/Linux/x86_64

It actually works today, unlike when I originally had tried it.

Anyway, it seems that the proposed changes are not actually needed, I'll close the PR.

@marcinjahn marcinjahn closed this Jul 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants