Skip to content
This repository has been archived by the owner on Sep 13, 2022. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hkcountryman committed Jan 1, 2021
1 parent d2f7d42 commit 4d10cd4
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![header](../assets/header_blue.png?raw=true)
![header](https://github.com/hkcountryman/latex_to_png/blob/assets/header_blue.png)
# ltxpng
This program lets you generate PNGs from LaTeX commands, which are saved as .tex files should you wish to edit your PNG. All created files can be found in ~/Documents/texdir.

Expand Down Expand Up @@ -28,11 +28,11 @@ sudo apt install [package name here]
## Instructions
Once you've followed the setup instructions, you can run ltxpng from the command line. It has some optional flags as well as one positional argument: a file name (alphanumeric characters and underscores, no extension). It can either be a new file or the name of an existing file. Provided you did not use the optional --no-gui flag, a window will pop up where you can type LaTeX commands, entering math mode however you like.

![new_tex](../assets/new_tex.png?raw=true)
![new_tex](https://github.com/hkcountryman/latex_to_png/blob/assets/new_tex.png)

Before you generate a PNG from your math, decide whether you want a transparent or a white background and select the appropriate radio button at the bottom of the window. Beside that, there are buttons to save the .tex file as well as to save it and generate a PNG from it. If you select the former, a .tex file will be saved in texdir. If you select the latter, the .tex file will be saved along with its PNG. You will also be given the option to save log files and PDF files. If you ever want to delete those extraneous files, there are optional flags to clean them from the directory.

![new_img](../assets/new_img.png?raw=true)
![new_img](https://github.com/hkcountryman/latex_to_png/blob/assets/new_img.png)

If you ever edit your generated .tex files through any means but the program's GUI, it is inadvisable to touch anything but the math you entered yourself. At best, you might cause the PNG to be formatted incorrectly. At worst you could make the file unreadable by the program. Be careful unless you [fully understand the LaTeX](https://github.com/hkcountryman/latex_to_png/wiki/Formatting-a-LaTeX-document-to-convert-to-PNG).

Expand Down

0 comments on commit 4d10cd4

Please sign in to comment.