Skip to content

Commit

Permalink
Update readme using jarvis
Browse files Browse the repository at this point in the history
  • Loading branch information
romanschejbal committed Oct 26, 2023
1 parent b07240d commit d449b73
Showing 1 changed file with 21 additions and 5 deletions.
26 changes: 21 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,25 @@
# rentr
A utility for running arbitrary commands when files change.
## Program Description

## Installation
`cargo install rentr`
This program is a utility for running arbitrary commands when files change. It is written in Rust and is similar to the `entr` tool.

The program takes a list of paths to watch for changes from stdin. When any of the watched files are modified, the program executes a provided command.

The program supports the following options:

- `-c` or `--clear`: Clears the screen before running the command.
- `-r` or `--reset`: Reloads a persistent child process.

The program uses the `notify` crate to watch for file changes and the `structopt` crate for command line argument parsing.

## Usage

To use the program, you can pipe a list of paths to watch from stdin and provide a command to execute when the files change. For example:

```
echo "my-folder" | rentr -c -r echo "my-folder has changed"
```

This will watch the `my-folder` directory for changes and execute the command `echo "my-folder has changed"` whenever a change occurs.

`find . | grep \.rs | rentr -c cargo build`
`find . | grep \.rs | rentr -c echo "CHANGED"`
`find . | grep \.rs | rentr -c echo "CHANGED"

0 comments on commit d449b73

Please sign in to comment.