diff --git a/README.md b/README.md index e5c1b7c..a498e35 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,38 @@ # Listen +> [!NOTE] +> This is the original implementation of `listen` in Perl. A rewritten, up-to-date verison in Go can be found in the new repository [here](https://forge.steck.dev/bryson/listen). + A simple automation program written in Perl that runs shell command(s) when the specified file(s) are modified. ## Why Use Listen? -* Don't switch between terminals and run that command every time! Let Listen do it for you. -* Very useful for singular files or small projects. - * For example, you can automatically compile a C++ file with `g++` anytime you make a change to that source file. - * Same goes for simple Python scripts, Bash scripts, etc. -* Great for students who work on a small set of source files for assignments. +- Don't switch between terminals and run that command every time! Let Listen do it for you. +- Very useful for singular files or small projects. + - For example, you can automatically compile a C++ file with `g++` anytime you make a change to that source file. + - Same goes for simple Python scripts, Bash scripts, etc. +- Great for students who work on a small set of source files for assignments. ## Other Features -* Run the command when any or all files specified are modified. -* Run the command before Listen starts waiting for modifications. -* Use `/bin/cksum` to determine file modification instead of the time. - * Could be useful for binaries. - * Distributed with Unix-like OSes, such as Linux, BSD, and macOS. No configuration required between OSes. - * However, if you use Windows (why?), you must use `certutils` or a third-party tool by modifying the script. -* Timeout between modifications - * Helpful if linters are involved, such as `clang-format`, to avoid multiple runs of a command. -* Free and Open Source software! +- Run the command when any or all files specified are modified. +- Run the command before Listen starts waiting for modifications. +- Use `/bin/cksum` to determine file modification instead of the time. + - Could be useful for binaries. + - Distributed with Unix-like OSes, such as Linux, BSD, and macOS. No configuration required between OSes. + - However, if you use Windows (why?), you must use `certutils` or a third-party tool by modifying the script. +- Timeout between modifications + - Helpful if linters are involved, such as `clang-format`, to avoid multiple runs of a command. +- Free and Open Source software! ## Documentation Most of these documents do not exist yet other than Listen's built in `--help` flag. -* [install.md](docs/install.md): Install instructions -* [usage.md](docs/usage.md): Basic operation of Listen -* [contributing.md](docs/contributing.md): Contributing guidelines for pull requests -* [LICENSE](LICENSE): Listen's license agreement +- [install.md](docs/install.md): Install instructions +- [usage.md](docs/usage.md): Basic operation of Listen +- [contributing.md](docs/contributing.md): Contributing guidelines for pull requests +- [LICENSE](LICENSE): Listen's license agreement ## License and Warranty Disclaimer