bryson/listen-perl
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

archive listen

Browse source
This commit is contained in:
Bryson Steck 2025-06-27 18:44:23 -06:00
parent 0e91b2f913
commit 1196823b8b
Signed by: bryson
SSH key fingerprint: SHA256:XpKABw/nP4z8UVaH+weLaBnEOD86+cVwif+QjuYLGT4
1 changed files with 21 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
README.md
View file

@ -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