Skip to content

Latest commit

 

History

History
54 lines (46 loc) · 2.3 KB

README.md

File metadata and controls

54 lines (46 loc) · 2.3 KB
Raw

LaTeX package Build Status

A simple package for Atom that compiles LaTeX files by invoking Latexmk.

Installing

Use the Atom package manager and search for "latex", or run apm install latex from the command line.

Prerequisites

TeX distribution

Since this package relies upon latexmk, a fully updated and working TeX distribution is required. The only current officially supported distribution is TeX Live, but MiKTeX has been reported to work.

You need to ensure that the package can find your TeX distribution; if you're using TeX Live and have installed to the default location then no further action should be required. To help the package find the distribution's binaries, you need to configure the TeX Path configuration variable to point to the folder containing the binaries. This can be done either in the settings view, or directly in your config.cson file.

Usage

Invoke the build command by pressing the default keybind ctrl-alt-b while in a .tex file.

Status

Please note that this package is in a beta state. Right now everything is very naïve. As an example, there's no proper error and warning handling.

TODO

Current wish list, in a semi-prioritized order.

  • Progress indicator.
  • Build output.
    • Error handling.
    • Warnings, and other non-critical messages.
  • BibTeX autocompletion support.
  • Open PDF automatically.
    • Configurable.
    • Support for other distributions, besides OS X.
    • Support for custom PDF viewer.
  • Support for compilers other than latexmk.
    • Partially supported via the "Builder" concept, but no alternative implementations have been created.
    • Support for texify compiler (MiKTeX).
    • Add support for non-PDF typesetting (e.g. dvi).
  • Project management.
    • Setting to override the output directory.
    • Setting to override the builder.

If you see something that's missing, or disagree with the prioritization, consider submitting a feature request, and if you're feeling super helpful, submit a pull request with an updated TODO list 💖