Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
dan committed Sep 22, 2023
1 parent 02d71cb commit fc3d7cc
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Mon-Mon
A monitor (service) for your monitor (display). Intercepts window behaviour when monitor configuration changes.
A monitor (service) for your monitor (display).

Listens for changes to display configuration (e.g. plugging in an additional screen) and allows you to blacklist monitors from displaying windows when they are initially connected - useful for public settings where you don't want to flood the audience with all of your open applications.

## Quick Start
1. `cp .env.example .env`
Expand All @@ -8,6 +10,12 @@ A monitor (service) for your monitor (display). Intercepts window behaviour when
## Installation
To make this app globally accessible, you can either drop the binary in your $PATH, or use `cargo`'s handy install command from the root of this project: `cargo install --path .`

You will then be able to run commands from your terminal from any directory, e.g. `$ monmon watch`

## Commands
- `monmon` - the default command; shoves everything to your primary display and exits.
- `monmon watch` - runs continually; will only move windows to the primary display if it detects a blacklisted monitor being plugged in (see [quick start](#quick-start))

## Running as Background Service
1. First make sure you have [installed](#installation) the `monmon` binary.
2. Determine the global installation path with `which monmon`
Expand Down

0 comments on commit fc3d7cc

Please sign in to comment.