github.com/aretext/aretext@v1.3.0/docs/install.md (about)

     1  Install
     2  =======
     3  
     4  Supported Platforms
     5  -------------------
     6  
     7  -	Linux
     8  -	macOS
     9  -	FreeBSD
    10  
    11  Official Binaries
    12  -----------------
    13  
    14  You can download the official binaries for Linux, macOS, and FreeBSD from [the aretext releases page](https://github.com/aretext/aretext/releases).
    15  
    16  ### Linux x86 64-bit
    17  
    18  ```
    19  VERSION=1.3.0
    20  RELEASE=aretext_${VERSION}_linux_amd64
    21  curl -LO https://github.com/aretext/aretext/releases/download/v$VERSION/$RELEASE.tar.gz
    22  tar -zxvf $RELEASE.tar.gz
    23  sudo cp $RELEASE/aretext /usr/local/bin/
    24  ```
    25  
    26  ### Linux ARM 64-bit
    27  
    28  ```
    29  VERSION=1.3.0
    30  RELEASE=aretext_${VERSION}_linux_arm64
    31  curl -LO https://github.com/aretext/aretext/releases/download/v$VERSION/$RELEASE.tar.gz
    32  tar -zxvf $RELEASE.tar.gz
    33  sudo cp $RELEASE/aretext /usr/local/bin/
    34  ```
    35  
    36  ### macOS x86 64-bit
    37  
    38  ```
    39  VERSION=1.3.0
    40  RELEASE=aretext_${VERSION}_darwin_amd64
    41  curl -LO https://github.com/aretext/aretext/releases/download/v$VERSION/$RELEASE.tar.gz
    42  tar -zxvf $RELEASE.tar.gz
    43  sudo cp $RELEASE/aretext /usr/local/bin/
    44  ```
    45  
    46  ### macOS ARM 64-bit
    47  
    48  ```
    49  VERSION=1.3.0
    50  RELEASE=aretext_${VERSION}_darwin_arm64
    51  curl -LO https://github.com/aretext/aretext/releases/download/v$VERSION/$RELEASE.tar.gz
    52  tar -zxvf $RELEASE.tar.gz
    53  sudo cp $RELEASE/aretext /usr/local/bin/
    54  ```
    55  
    56  Build From Source
    57  -----------------
    58  
    59  If you have [installed go](https://golang.org/doc/install), then you can build aretext from source:
    60  
    61  ```
    62  mkdir -p $(go env GOPATH)/bin
    63  git clone https://github.com/aretext/aretext.git
    64  cd aretext
    65  make install
    66  ```
    67  
    68  This will install aretext in `$(go env GOPATH)/bin`, which you can add to your `$PATH` environment variable. If you use bash, put this line in your `~/.bashrc` or `~/.bash_profile`:
    69  
    70  ```
    71  export PATH=$PATH:$(go env GOPATH)/bin
    72  ```
    73  
    74  Packages
    75  --------
    76  
    77  If a package is not yet available for your platform, please consider creating one! We are looking for package maintainers on Debian, Fedora, Homebrew, Nix, and any other platform you may prefer!
    78  
    79  ### Arch Linux
    80  
    81  aretext is available as an [AUR Package](https://aur.archlinux.org/packages/aretext-bin/). If you use [yay](https://github.com/Jguer/yay), run this to install it:
    82  
    83  ```shell
    84  yay -S aretext
    85  ```