diff --git a/README.md b/README.md index a7be5b1a96b12251f30c05ce2b1bffe2df3bf20f..9841bcdcc02196393fa7429ed386c1d1e285a7a9 100644 --- a/README.md +++ b/README.md @@ -30,76 +30,8 @@ ![Demo GIF](public/assets/demo.gif) ## Installation -There are several ways to install Matcha: -### Package Managers - -#### Homebrew (macOS & Linux) - -```bash -brew tap floatpane/matcha -brew install floatpane/matcha/matcha -``` - -After installation, run: - -```bash -matcha -``` - -> [!WARNING] -> If you have the [*"other"* Matcha](https://github.com/piqoni/matcha) already installed, you will have to rename the executable - - -### Install using Snap (Linux) - -> [!NOTE] -> When using Snap, the config folder is going to be located at `~/snap/matcha/36/.config`, see [why](https://github.com/floatpane/matcha/issues/117) - -```bash -sudo snap install matcha -``` - -### Build from Source - -Matcha is written in **Go**. To build it manually: - -1. Ensure you have Go installed (`go version`). -2. Clone the repository: - - ```bash - git clone https://github.com/floatpane/matcha.git - ``` - -3. Navigate to the project folder: - - ```bash - cd matcha - ``` - -4. Build the binary: - - ```bash - go build -trimpath -ldflags="-s -w" -o matcha - ``` - - For an even smaller binary, compress with UPX (install via `brew install upx` or `apt install upx`): - - ```bash - upx --best --lzma matcha - ``` - -> [!WARNING] -> UPX compression does NOT work on macOS ARM builds. See [#97](https://github.com/floatpane/matcha/pull/97) - -5. Run it: - ```bash - ./matcha - ``` - -### Open Build Service - -Also, a build of Matcha is available on [OBS](https://build.opensuse.org/package/show/home:mantarimay:apps/matcha). Thanks, [@mantarimay](https://github.com/mantarimay)! +View [INSTALLATION.md](docs/INSTALLATION.md) ## Features diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md new file mode 100644 index 0000000000000000000000000000000000000000..001ba5804ae8680dfb5b2c106316f31ab4ff034d --- /dev/null +++ b/docs/INSTALLATION.md @@ -0,0 +1,112 @@ +# Installation Guide + +Welcome to the installation guide for Matcha. + +## Table of Contents + +- [ MacOS](#macos) + - [Homebrew](#homebrew) + - [Manual Binary Download](#manual-binary-download) +- [🐧 Linux](#linux) + - [Homebrew](#homebrew-1) + - [Snap](#snap) + - [Flatpak](#flatpak) + - [Manual Binary Download](#manual-binary-download-1) +- [🪟 Windows](#windows) + - [WSL](#wsl) +- [🏗️ Building from Source](#building-from-source) + +##  MacOS + +### 🍺 Homebrew + +The recommended way to install Matcha on macOS is via Homebrew. + +```bash +brew tap floatpane/matcha +brew install floatpane/matcha/matcha +``` + +After installation, run: + +```bash +matcha +``` + +> [!WARNING] +> If you have the [*"other"* Matcha](https://github.com/piqoni/matcha) already installed, you will have to rename the executable to avoid conflicts. + +### Manual Binary Download + +You can download pre-compiled binaries from the [Releases page](https://github.com/floatpane/matcha/releases). + +1. Download the appropriate archive for your architecture (e.g., `matcha_0.17.0_darwin_amd64.tar.gz` or `matcha_0.17.0_darwin_arm64.tar.gz`). +2. Extract the archive. +3. Move the binary to your path: + ```bash + mv matcha /usr/local/bin/ + ``` +4. Run it: + ```bash + matcha + ``` + +## 🐧 Linux + +### 🍺 Homebrew + +You can also install Matcha on Linux via Homebrew. + +```bash +brew tap floatpane/matcha +brew install floatpane/matcha/matcha +``` + +### Snap + +Matcha is available on the Snap Store. + +```bash +sudo snap install matcha +``` + +### Flatpak + +You can install Matcha via Flatpak using the following command: + +```bash +flatpak install https://matcha.floatpane.com/matcha.flatpakref +``` + +### Manual Binary Download + +You can download pre-compiled binaries from the [Releases page](https://github.com/floatpane/matcha/releases). + +1. Download the appropriate archive for your architecture (e.g., `matcha_0.17.0_linux_amd64.tar.gz` or `matcha_0.17.0_linux_arm64.tar.gz`). +2. Extract the archive. +3. Move the binary to your path: + ```bash + mv matcha /usr/local/bin/ + ``` +4. Run it: + ```bash + matcha + ``` + +## 🪟 Windows + +Currently, there is no native support for Windows. Please see issue [#123](https://github.com/floatpane/matcha/issues/123) for more details. + +### WSL + +You can run Matcha on Windows using [WSL (Windows Subsystem for Linux)](https://learn.microsoft.com/en-us/windows/wsl/install). + +Once you have WSL installed and set up, you can follow the [Linux](#linux) installation instructions inside your WSL terminal. + +## 🏗️ Building from Source + +If you have Go installed, you can build Matcha from source: + +```bash +go build . +```