From cdd4095cab5b66ebba21f710e5c508bdb24d79ce Mon Sep 17 00:00:00 2001
From: Phani Pavan K <kphanipavan@gmail.com>
Date: Mon, 8 Sep 2025 23:28:32 +0530
Subject: [PATCH] add some readme, change log folder name to pdf

---
 README.md             | 25 ++++++++++++++++++++++++-
 setupFiles/install.sh |  6 +++---
 2 files changed, 27 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 868ff0f..4ef4d83 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,26 @@
 # AutoLTX
 
-Automated build system for compiling Latex Files, mimicing the Overleaf build system.
\ No newline at end of file
+Automated build system for compiling Latex Files, mimicing the Overleaf build system.
+
+1. Build the docker container using:
+```bash
+docker build -t autoltx:latest .
+```
+
+2. Download the overleaf project as a zip file or using the git integration to easily push any changes.
+
+3. Use the following command to attach the project folder to the built container.
+
+```bash
+docker run --rm -it -e "mainFile=<mainTEXfile>" -v <projectFolderPath>:/app/project:z --user 1000:1000 autoltx:latest
+```
+
+replace `<mainTEXfile>` with the  primary tex file to compile,  `<projectFolderPath>` with the path to the project folder.
+
+This will compile your project whenever a change is observed in the `mainTEXfile` file.
+
+### Observables:
+
+- The container will create a new folder `pdf` which contains all the build files.
+- Once the project compiles, the result is put into the `<projectFolderPath>`, called `output.pdf`. Keep it open so any changes to the main tex file, triggers a pdf update. Other files include `compile.sh`: the main compilation script, `latexmkrc`: used by the `latexmk` compiler, edit cautiously, and `.autoltx`: used for versioning the container scripts.
+- These files are added to gitignore if present to avoid tracking unnecessary files by git.
diff --git a/setupFiles/install.sh b/setupFiles/install.sh
index 0fdd064..f710023 100644
--- a/setupFiles/install.sh
+++ b/setupFiles/install.sh
@@ -10,7 +10,7 @@ if test -f ".autoltx"; then
 else
 if test -f ".gitignore"; then
     # Adding build files to .gitignore
-    grep -qxF 'build/' .gitignore || echo 'build/' >> .gitignore
+    grep -qxF 'pdf/' .gitignore || echo 'pdf/' >> .gitignore
     grep -qxF 'latexmkrc' .gitignore || echo 'latexmkrc' >> .gitignore
     grep -qxF 'compile.sh' .gitignore || echo 'compile.sh' >> .gitignore
     grep -qxF '.autoltx' .gitignore || echo '.autoltx' >> .gitignore
@@ -18,10 +18,10 @@ if test -f ".gitignore"; then
     echo Configuring AutoLTX for this project
 else
     # Creating .gitignore file
-    printf 'build/\nlatexmkrc\ncompile.sh\n' >> .gitignore
+    printf 'pdf/\nlatexmkrc\ncompile.sh\n' >> .gitignore
 fi
 
-# mkdir -p build/config
+# mkdir -p pdf/config
 
 # Add latexmk rc file to build files
 cp /app/setupFiles/latexmkrc /app/project/