diff --git a/README.md b/README.md index 83b638d..0cf251b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,8 @@ ## ServTeX +ServTeX is a webserver which auto-compiles your LaTeX project and serves it without any input. +It is intended to be run on a second monitor while you edit your project on the first. +Syncing is not handled directly by ServTeX so you can use syncthing, rsync, etc. + I made this because I wanted something like this. I have been learning Goland along the way, so some code may seem odd. ### AI-Disclaimer @@ -9,10 +13,8 @@ To reduce the 404s I also generated the favicon. ### Usage Download the latest release. -Extract to an empty directory and run. -You may want to change the configuration as needed. - -Syncing of the TeX files is not handled by ServTeX. Use syncthing, rsync or whatever else you want. +Extract to an empty directory and change the configuration as needed. +Configure syncing via a solution of your choice and start the server. ### Development ```go