Skip to content

Commit

Permalink
improvements in doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Rendscode committed Feb 1, 2024
1 parent 95976c3 commit e1ececf
Showing 1 changed file with 17 additions and 5 deletions.
22 changes: 17 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
Assumed directory structure
The shell script `movelatexoutput.sh` makes sure that the output of a LaTeX 2 PDF process is stored in a separate folder and both folder and generated PDF change their names according to the name of the git branch.
This requires a git administered bunch of .tex files


### Assumed directory structure
```
.
├── .git
├── <outputfolder>
│   ├── <branchname1>
│   │   └── <branchname1>.pdf
Expand All @@ -19,9 +24,16 @@ Assumed directory structure
└── movelatexoutput.sh
```

### LaTeX scenario:
- Each document is based on the same latex template ('sample.tex'), which includes a ''content.tex'' file.
- The content file is changing for each document.
- Each document and thus each content file is stored in a separate GIT branch.

The git repository lies within the main directory.

**The shell script copies the generated PDF to a subdirectory named according to the name of the GIT branch and also renames the PDF file to the branch name.**

Each document is based on the same latex template ('sample.tex'), which includes a ''content.tex'' file.
The content file is changing for each document.
Each document and thus each content file is stored in a separate GIT branch.
### Usage:
`$ ./movelatexoutput <outputfolder>`

The shell script copies the generated PDF to a subdirectory named according to the name of the GIT branch and also renames the PDF file to the branch name.
The name of the output directory "<outputfolder>" parameter is mandatory.

0 comments on commit e1ececf

Please sign in to comment.