Skip to content

Commit

Permalink
chore: Added README file content
Browse files Browse the repository at this point in the history
README now describes usage scenarios and build instructions
  • Loading branch information
alexdemb committed May 14, 2024
1 parent 980023c commit 27ae8c4
Showing 1 changed file with 70 additions and 1 deletion.
71 changes: 70 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,70 @@
# mutter-display-presets
# Mutter Display Presets
[![Rust](https://github.com/alexdemb/mutter-display-presets/actions/workflows/rust.yml/badge.svg)](https://github.com/alexdemb/mutter-display-presets/actions/workflows/rust.yml)

# Overview
Mutter Display Presets is a command line application that allows to configure display layout presets for Mutter compositor on Wayland.

# Installation
TBD

# Quick start

Current display configuration can be saved as preset 'Work' using following command:

```shell
$ ./mutter-display-presets.AppImage save Work
```

After creating multiple presets for each use case, they can be listed:

```shell
$ ./mutter-display-presets.AppImage list
Work
Gaming
TV
```

To switch to different preset, use 'apply' subcommand:

```shell
$ ./mutter-display-presets.AppImage apply Gaming
```

# Help
```shell
$ ./mutter-display-presets.AppImage --help
Usage: mutter-display-presets.AppImage [OPTIONS] <COMMAND>

Commands:
save Save current display configuration as a preset
apply Apply display configuration from specified preset
list List available presets
delete Delete preset with specified name
rename Rename display configuration preset
show Print information about preset
help Print this message or the help of the given subcommand(s)

Options:
-v, --verbose
Verbose mode. Print more log messages

-c, --config <config>
Path to the configuration file. When not specified explicitly,
'$XDG_CONFIG_HOME/display-presets.json' will be used. If environment variable 'XDG_CONFIG_HOME' is not set, '$HOME/.config/display-presets.json' will be used.


-t, --timeout <timeout>
Timeout (in seconds) for communication with Mutter D-Bus interface. 10 seconds by default

-h, --help
Print help (see a summary with '-h')

-V, --version
Print version
```

# Build
```shell
$ cd code/
$ cargo build
```

0 comments on commit 27ae8c4

Please sign in to comment.