README Update

[kellen-miller]

Issue Overview

Context: lensapp/lens#5444 (comment)

Update README.md to address the following

• Improve formatting
• Add homebrew install instructions
• Clarify OpenLens vs Lens IDE

--- Can't submit a PR, so pasting updated README.md below ---

OpenLens Build Repo

Build Repo Only

This is repo only provides binaries for the OpenLens repo. For software issues regarding OpenLens or the Lens IDE, go to the Lens repo and open an issue there. They will be closed if opened on this repo.

Overview

This is the Binary Build Repo for the Lens repository aka OpenLens. This build only includes the open source part of the Lens IDE and does not require login. This repo was created due to lensapp/lens#5444.

Download and use as is. If you have trouble about not seeing pod logs, remove old config files / extensions remaining from old Lens app.

Auto Updater is now live starting with every binary downloaded with the Latest tag or the corresponding release assets.

OpenLens vs Lens IDE

Paraphrasing from the OpenLens README

OpenLens

The OpenLens repository, is where Team Lens (Mirantis) develops the Lens IDE product together with the community. It is backed by a number of Kubernetes and cloud native ecosystem pioneers. This source code is available to everyone under the MIT license.

Lens IDE

The Kubernetes management tool Lens IDE is a distribution of the OpenLens repository with Team Lens specific customizations released under a traditional EULA.

Installation

Manual

Go to Releases and download the relevant binary for your system.

MacOS

Homebrew

brew install --cask openlens

Linux

todo

Windows

todo

[siko1056]

The brew tab step was not necessary in my case https://formulae.brew.sh/cask/openlens.

[marafa-sugarcrm]

the correct command is brew install --cask openlens from https://formulae.brew.sh/cask/openlens

[marafa-sugarcrm]

if the readme needs to point to the upstream repo, then instead lets state something like, this is only a build repo and only provides binaries.
any issues with the software to go to the upstream repo and open an issue there

[kellen-miller]

@siko1056

The brew tab step was not necessary in my case https://formulae.brew.sh/cask/openlens.

oh sweet, I didn't see it was already in homebrews casks. That works then, will update the issue.

@marafa-sugarcrm

the correct command is brew install --cask openlens from https://formulae.brew.sh/cask/openlens
Updated

if the readme needs to point to the upstream repo, then instead lets state something like, this is only a build repo and only provides binaries.
any issues with the software to go to the upstream repo and open an issue there

Good call out, will updated readme right at the top so people cant miss it.