Skip to content

Commit

Permalink
chore: Added installation instructions to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alexdemb committed May 14, 2024
1 parent d76dd36 commit 4a1ca9c
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,22 @@
Mutter Display Presets is a command line application that allows to configure display layout presets for Mutter compositor on Wayland.

# Installation
TBD
1. Download archive with [latest version](https://github.com/alexdemb/mutter-display-presets/actions/runs/9080723445/artifacts/1501336929).

2. Extract archive and make AppImage executable:
```shell
$ unzip mutter-display-presets.AppImage.zip
$ chmod +x ./mutter-display-presets.AppImage
```

3. (Optional) You can also move app to your PATH location, e.g. `~/.local/bin`:
```shell
$ mv ./mutter-display-presets.AppImage ~/.local/bin/mutter-display-presets
```
Then it can be used in a simple way:
```shell
$ mutter-display-presets
```

# Quick start

Expand Down Expand Up @@ -64,6 +79,9 @@ Options:
```

# Build

Application is written in Rust and can be compiled using simple `cargo build` command:

```shell
$ cd code/
$ cargo build
Expand Down

0 comments on commit 4a1ca9c

Please sign in to comment.