remove echo in df, add badges
This commit is contained in:
10
Dockerfile
10
Dockerfile
@@ -1,23 +1,21 @@
|
|||||||
FROM alpine:3.22
|
FROM alpine:3.22
|
||||||
|
|
||||||
# update and install latex packages
|
# Update and install latex packages
|
||||||
RUN echo test
|
|
||||||
RUN apk update
|
RUN apk update
|
||||||
RUN apk add entr texlive-full
|
RUN apk add entr texlive-full
|
||||||
|
|
||||||
# creating container structure
|
# Creating container structure
|
||||||
ENV mainFile=""
|
ENV mainFile=""
|
||||||
RUN addgroup -g 1000 -S ltxgroup && adduser -u 1000 -S -G ltxgroup ltxuser
|
RUN addgroup -g 1000 -S ltxgroup && adduser -u 1000 -S -G ltxgroup ltxuser
|
||||||
RUN mkdir -p /app && chown -R ltxuser:ltxgroup /app
|
RUN mkdir -p /app && chown -R ltxuser:ltxgroup /app
|
||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
|
|
||||||
# copy install scripts
|
# Copy install scripts
|
||||||
USER ltxuser
|
USER ltxuser
|
||||||
COPY --chown=ltxuser:ltxgroup startup.sh /app/startup.sh
|
COPY --chown=ltxuser:ltxgroup startup.sh /app/startup.sh
|
||||||
RUN chmod +x /app/startup.sh
|
RUN chmod +x /app/startup.sh
|
||||||
RUN echo arstearst
|
|
||||||
COPY --chown=ltxuser:ltxgroup setupFiles /app/setupFiles
|
COPY --chown=ltxuser:ltxgroup setupFiles /app/setupFiles
|
||||||
RUN chmod +x /app/setupFiles/install.sh
|
RUN chmod +x /app/setupFiles/install.sh
|
||||||
|
|
||||||
|
# Startup command
|
||||||
CMD [ "sh", "-c", "/app/startup.sh ${mainFile}" ]
|
CMD [ "sh", "-c", "/app/startup.sh ${mainFile}" ]
|
||||||
# CMD [ "ls", "|", "entr", "ls", "-hla" ]
|
|
||||||
|
|||||||
22
README.md
22
README.md
@@ -1,15 +1,29 @@
|
|||||||
# AutoLTX
|
# AutoLTX
|
||||||
|
  
|
||||||
|
|
||||||
Automated build system for compiling Latex Files, mimicing the Overleaf build system.
|
Automated build system for compiling Latex Files, mimicing the Overleaf build system.
|
||||||
|
|
||||||
1. Build the docker container using:
|
## Download
|
||||||
|
|
||||||
|
This image is published to dockerhub, pull it using
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker pull phanipavank/autoltx:latest
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## Building
|
||||||
|
|
||||||
|
The [DockerFile](./DockerFile) is provided in the root folder of this repo. Build the docker container using
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker build -t autoltx:latest .
|
docker build -t autoltx:latest .
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Download the overleaf project as a zip file or using the git integration to easily push any changes.
|
## Usage
|
||||||
|
1. Download the overleaf project as a zip file or using the git integration for easier integration.
|
||||||
|
|
||||||
3. Use the following command to attach the project folder to the built container.
|
2. Use the following command to attach the project folder to the built container.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker run --rm -it -e "mainFile=<mainTEXfile>" -v <projectFolderPath>:/app/project:z --user 1000:1000 autoltx:latest
|
docker run --rm -it -e "mainFile=<mainTEXfile>" -v <projectFolderPath>:/app/project:z --user 1000:1000 autoltx:latest
|
||||||
@@ -19,7 +33,7 @@ replace `<mainTEXfile>` with the primary tex file to compile, `<projectFolderP
|
|||||||
|
|
||||||
This will compile your project whenever a change is observed in the `mainTEXfile` file.
|
This will compile your project whenever a change is observed in the `mainTEXfile` file.
|
||||||
|
|
||||||
### Observables:
|
## Observables:
|
||||||
|
|
||||||
- The container will create a new folder `pdf` which contains all the build files.
|
- 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.
|
- 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.
|
||||||
|
|||||||
Reference in New Issue
Block a user