Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

arara

arara

Language: Kotlin Minimum JRE: 8.0

arara is a TeX automation tool based on rules and directives. It gives you a way to enhance your TeX experience. The tool is an effort to provide a concise way to automate the daily TeX workflow for users and also package writers. Users might write their own rules when the provided ones do not suffice.

Please note that arara recently moved. We are proud to announce that arara is now part of the Island of TeX. The new address is https://gitlab.com/islandoftex/arara. The old GitHub repository will be used as mirror but development happens on GitLab. Please open relevant issues and merge requests there.

Basic use

To use arara, you need to tell it what to do. Unlike most other tools, you give arara these directives in the document itself – usually near the top. So to run pdflatex once on your document, you should say something like:

% arara: pdflatex
\documentclass{article}
\begin{document}
Hello, world!
\end{document}

Now when you run arara myfile, that directive (% arara: ...) will be seen and carried out as described by the pdflatex rule. You can read more about rules and directives in the user manual available in our releases section. In addition to documenting all of the rules that come standard with arara, the manual gives a detailed explanation of how arara works, as well as how to create and use your own rules.

Getting the latest and greatest arara

arara is continuously built by the GitLab CI. For each and every commit, it is ensured that a green tick means arara passes the test suite and is ready to be tested. However, that is not meant you can use the executable artifacts of the builds for productive use.

Development of arara takes place in the development branch. Feel free to be one of our testers and enjoy the latest features and bug fixes by building from there.

Support

We use a Gitter chatroom for discussing things related to arara. You are more than welcome to come join the fun and say hi! to us. We also have the issues section in our repository as a valid channel to report problems, bugs and suggest improvements.

Localization

Would you like to make arara speak your own language? Splendid! We would love to have you in the team! Just send us an e-mail, join our dedicated chatroom or open an issue about it. The localization process is quite straightforward, we can help you! Any language is welcome!

A big thanks to our translators Marco Daniel, Clemens Niederberger, Ulrike Fischer, Gert Fischer, Enrico Gregorio and Marijn Schraagen for the awesome localization work!

Downloads

Download from GitLab

Our tool is available out of the shelf on all major TeX distributions, including TeX Live and MiKTeX, which makes manual installation unnecessary given the significant coverage of such distributions. Chances are you already have arara in your system!

You can obtain the official package available in the releases section of our project repository. Please refer to the documentation on how to manually deploy our tool.

License

This application is licensed under the New BSD License. Please note that the New BSD License has been verified as a GPL-compatible free software license by the Free Software Foundation, and has been vetted as an open source license by the Open Source Initiative.

The team

arara, the cool TeX automation tool, is brought to you by Paulo Cereda, Marco Daniel, Brent Longborough, Nicola Talbot and Ben Frank. If you want to support TeX development by a donation, the best way to do this is donating to the TeX Users Group.

About

arara is a TeX automation tool based on rules and directives. It gives you a way to enhance your TeX experience. This is a mirror repository.

Topics

Resources

License

Packages

No packages published
You can’t perform that action at this time.