Skip to content

Commit

Permalink
Linux package installation in README.
Browse files Browse the repository at this point in the history
  • Loading branch information
qa-swaneet-sahoo committed Apr 26, 2022
1 parent 7e938f2 commit 552bd75
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 8 deletions.
25 changes: 21 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,34 @@ human-readable text formats.
`protocurl` includes and uses a bundled `protoc` by default. It is recommended to install `curl` into PATH for
configurable http requests. Otherwise `protocurl` will use a simple non-configurable fallback http implementation.

#### Native CLI
### Native CLI

**Archive**

1. Download the latest release archive for your platform from https://github.com/qaware/protocurl/releases
2. Extract the archive into a folder, e.g. `/opt/protocurl`.
3. Add symlink to the binary in the folder. e.g. `ln -s /opt/protocurl/bin/protocurl /usr/bin/protocurl`
Or add the binary folder `/opt/protocurl/bin` to your system-wide path.
4. Test that it works via `protocurl -h`
4. Test it via `protocurl -h`

**Debian .deb package**

1. Download the latest release `.deb` for your architecture from https://github.com/qaware/protocurl/releases
2. Install dependency curl: `sudo apt install curl`
3. Install `sudo dpkg -i <downloaded-release>.deb`
4. Test it via `protocurl -h`

**Alpine .apt package**

1. Download the latest release `.apk` for your architecture from https://github.com/qaware/protocurl/releases
2. Install dependencies curl and gcompat: `sudo apk add curl gcompat`
3. Install `sudo apk add --alow-untrusted <downloaded-release>.apk`
4. Test it via `protocurl -h`

#### Docker
### Docker

Simply run `docker run -v "/path/to/proto/files:/proto" qaware/protocurl <args>`. See [Quick Start](#quick-start) for how to use.
Simply run `docker run -v "/path/to/proto/files:/proto" qaware/protocurl <args>`. See [Quick Start](#quick-start) for
how to use.

## Quick Start

Expand Down
25 changes: 21 additions & 4 deletions doc/template.README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,34 @@ human-readable text formats.
`protocurl` includes and uses a bundled `protoc` by default. It is recommended to install `curl` into PATH for
configurable http requests. Otherwise `protocurl` will use a simple non-configurable fallback http implementation.

#### Native CLI
### Native CLI

**Archive**

1. Download the latest release archive for your platform from https://github.com/qaware/protocurl/releases
2. Extract the archive into a folder, e.g. `/opt/protocurl`.
3. Add symlink to the binary in the folder. e.g. `ln -s /opt/protocurl/bin/protocurl /usr/bin/protocurl`
Or add the binary folder `/opt/protocurl/bin` to your system-wide path.
4. Test that it works via `protocurl -h`
4. Test it via `protocurl -h`

**Debian .deb package**

1. Download the latest release `.deb` for your architecture from https://github.com/qaware/protocurl/releases
2. Install dependency curl: `sudo apt install curl`
3. Install `sudo dpkg -i <downloaded-release>.deb`
4. Test it via `protocurl -h`

**Alpine .apt package**

1. Download the latest release `.apk` for your architecture from https://github.com/qaware/protocurl/releases
2. Install dependencies curl and gcompat: `sudo apk add curl gcompat`
3. Install `sudo apk add --alow-untrusted <downloaded-release>.apk`
4. Test it via `protocurl -h`

#### Docker
### Docker

Simply run `docker run -v "/path/to/proto/files:/proto" qaware/protocurl <args>`. See [Quick Start](#quick-start) for how to use.
Simply run `docker run -v "/path/to/proto/files:/proto" qaware/protocurl <args>`. See [Quick Start](#quick-start) for
how to use.

## Quick Start

Expand Down

0 comments on commit 552bd75

Please sign in to comment.