Skip to content

Commit

Permalink
Move installation instructions to the top of the README
Browse files Browse the repository at this point in the history
  • Loading branch information
Tom94 committed Jan 29, 2023
1 parent cdc301a commit bd0f7f0
Showing 1 changed file with 19 additions and 16 deletions.
35 changes: 19 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,25 @@ The following file formats are supported:
![Screenshot](https://raw.githubusercontent.com/Tom94/tev/master/resources/screenshot.png)
_A false-color comparison of two multi-layer OpenEXR images of a beach ball. Image courtesy of [openexr-images](https://github.com/openexr/openexr-images)._

## Installation

### Windows

Download the __tev__ executable (.exe) from the [releases page](https://github.com/Tom94/tev/releases).

### macOS

Download the __tev__ application (.dmg) from the [releases page](https://github.com/Tom94/tev/releases) or install it via homebrew.
```bash
brew install --cask tev
```

### Linux

Download the __tev__ application (.appimage) from the [releases page](https://github.com/Tom94/tev/releases). See [how to run AppImages](https://appimage.org/).

On Arch Linux you can also install __tev__ from the [Arch User Repository](https://aur.archlinux.org/packages/tev/).

## Usage

### Graphical User Interface
Expand Down Expand Up @@ -77,22 +96,6 @@ where integers are encoded in little endian.
There are helper functions in [Ipc.cpp](src/Ipc.cpp) (`IpcPacket::set*`) that show exactly how each packet has to be assembled. These functions do not rely on external dependencies, so it is recommended to copy and paste them into your project for interfacing with __tev__.


## Obtaining tev

### macOS / Windows

Pre-built binaries for Windows (32-bit and 64-bit) and macOS (64-bit, arm) are available on the [releases page](https://github.com/Tom94/tev/releases).

On macOS, __tev__ can also be installed via homebrew:
```bash
brew install --cask tev
```

### Linux

- Pre-built portable Linux binaries (64-bit) are available on the [releases page](https://github.com/Tom94/tev/releases). See [how to run AppImages](https://appimage.org/).
- Archlinux: available on the [Arch User Repository](https://aur.archlinux.org/packages/tev/)

## Building tev

All that is required for building __tev__ is a C++20-compatible compiler. Begin by cloning this repository and all its submodules using the following command:
Expand Down

0 comments on commit bd0f7f0

Please sign in to comment.