Skip to content

Commit

Permalink
Address suggestions
Browse files Browse the repository at this point in the history
  • Loading branch information
afontani committed Feb 7, 2025
1 parent 7303ff7 commit 997cc80
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/technical_reference_guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ $ docker pull mfisherman/texlive-full
docker run --rm -it -v $(pwd):/workspace mfisherman/texlive-full /bin/bash
```

4. The container should start running imediately. The container by default will start in a "data" folder with nothing in the directory. Go to the workspace folder where the Technical Reference Guide directory is located.
4. The container should start running immediately. Once in the container, your CLI looks something like this: `19603f1794b0:/data#`, with `19603f1794b0` likely being different. Go to the workspace folder where the Technical Reference Guide directory is located.

```
cd ../workspace
Expand All @@ -48,3 +48,5 @@ latexmk -pdf -latexoption=-file-line-error -latexoption=-interaction=nonstopmode

6. All of the pdf and log files from the compile will be located in docs/technical_reference_guide/_build (Note: this won't show up as modified files in git because _build is in .gitignore)

7. If the pdf does not compile successfully, look for fatal errors in the .log file, apply fixes, and recompile as needed by repeating step 5. To stop the workflow and exit out of the container, type exit in the CLI or hit Ctrl + D on your keyword.

0 comments on commit 997cc80

Please sign in to comment.