diff --git a/README.md b/README.md index 0637e32..769ef3b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,20 @@ # Useful_scripts_and_documents -I upload the things that migth be useful for someone, someday... \ No newline at end of file +I upload the things that migth be useful for someone, someday... + +# autocompile.sh + +Auto-pulls, watches, and recompiles a `.tex` file with `pdflatex` on save (via `inotifywait`), opens the PDF in Evince, and auto-commits + pushes back to your git remote on exit (Ctrl+C). + +## Requirements +`git`, `pdflatex`, `inotify-tools`, `evince`, `termux-x11`, `fluxbox`, `wmctrl` or `xdotool` (Termux/Android setup). + +## Usage +```bash +./autocompile.sh yourfile.tex +``` +If the file doesn't exist, a minimal template is created for you. + +## Notes +- Requires a configured git remote (`origin`) with push access. +- Network operations (pull/push) time out gracefully after 10s if offline. \ No newline at end of file