Skip to content

Commit

Permalink
Update readme install instructions (#63)
Browse files Browse the repository at this point in the history
  • Loading branch information
felicianotech committed Feb 22, 2023
1 parent 4021ec8 commit 3753d0b
Showing 1 changed file with 31 additions and 10 deletions.
41 changes: 31 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,41 @@ Overtime, we'll be adding more support until it comes into feature parity with t

## Table of Contents

- [Install arc](#install-arc)
- [Installation](#installation)
- [Linux](#linux)
- [macOS](#macos)
- [Windows](#windows)
- [Usage](#usage)


## Install arc
## Installation

### Linux

There are a few ways you can install arc on a Linux amd64 or arm64 system.

#### Ubuntu Apt Repository (recommended)
I (Ricardo N Feliciano) run an Apt/Debian repository for a lot of my software, which includes Arc.
The benefit of the Apt repository is that updates are handled by Ubuntu's built-in package manager.

For security reasons, first we install the GPG key for the repository:

```bash
sudo wget "http://pkg.feliciano.tech/ftech-archive-keyring.gpg" -P /usr/share/keyrings/
```

Now we add the repository to the system:

```bash
echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/ftech-archive-keyring.gpg] http://pkg.feliciano.tech/ubuntu $(lsb_release -sc) main" | sudo tee /etc/apt/sources.list.d/felicianotech.list
```

Finally, we can install Arc:

```bash
sudo apt update && sudo apt install hubci-arc
```

#### Debian Package (.deb)
You can install arc on an Apt based operating system by downloading the `.deb` file to the desired system.

Expand All @@ -29,28 +51,27 @@ Many distros allow you to double-click the file to install.
Via terminal, you can do the following:

```bash
wget https://github.com/hubci/arc/releases/download/v0.1.0/arc_0.1.0_amd64.deb
sudo dpkg -i arc_0.1.0_amd64.deb
wget https://github.com/hubci/arc/releases/download/v0.10.0/arc_0.10.0_amd64.deb
sudo dpkg -i arc_0.10.0_amd64.deb
```

`0.1.0` and `amd64` may need to be replaced with your desired version and CPU architecture respectively.
`0.10.0` and `amd64` may need to be replaced with your desired version and CPU architecture respectively.

#### Binary Install
You can download and run the raw arc binary from the [GitHub Releases page][gh-releases] if you don't want to use any package manager.
Simply download the tarball for your OS and architecture and extract the binary to somewhere in your `PATH`.
Here's one way to do this with `curl` and `tar`:

```bash
dlURL="https://github.com/hubci/arc/releases/download/v0.1.0/arc-v0.1.0-linux-amd64.tar.gz"
dlURL="https://github.com/hubci/arc/releases/download/v0.10.0/arc-v0.10.0-linux-amd64.tar.gz"
curl -sSL $dlURL | sudo tar -xz -C /usr/local/bin arc
```

`0.1.0` and `amd64` may need to be replaced with your desired version and CPU architecture respectively.
`0.10.0` and `amd64` may need to be replaced with your desired version and CPU architecture respectively.

### macOS

There are two ways you can install arc on a macOS (amd64) system.
Support for M1 macs (the arm64 chip) is coming later in 2021.

#### Brew (recommended)

Expand All @@ -66,11 +87,11 @@ Simply download the tarball for your OS and architecture and extract the binary
Here's one way to do this with `curl` and `tar`:

```bash
dlURL="https://github.com/hubci/arc/releases/download/v0.1.0/arc-v0.1.0-macos-amd64.tar.gz"
dlURL="https://github.com/hubci/arc/releases/download/v0.10.0/arc-v0.10.0-macos-amd64.tar.gz"
curl -sSL $dlURL | sudo tar -xz -C /usr/local/bin arc
```

`0.1.0` may need to be replaced with your desired version.
`0.10.0` may need to be replaced with your desired version.

### Windows

Expand Down

0 comments on commit 3753d0b

Please sign in to comment.