Skip to content
/ lins Public

Lins is a lightweight, extensible linter for prose—specifically developed with LaTeX in mind.

License

Notifications You must be signed in to change notification settings

sthenic/lins

Repository files navigation

NIM LICENSE tests

lins

Lins is a lightweight, extensible linter for prose—specifically developed with LaTeX in mind. The tool is written in Nim and inspired by Vale.

Documentation

The project's documentation is available here.

Building

If none of the release packages targets your platform, you can still build and use this tool provided that you have a C compiler that targets your platform.

  1. Download and install the Nim compiler and its tools.

  2. Clone this repository and run

    nimble install
    
  3. Since Lins relies on PCRE for its regular expression support via dynamic linking, you will also have to build or install PCRE as a library.

Version numbers

Releases follow semantic versioning to determine how the version number is incremented. If the specification is ever broken by a release, this will be documented in the changelog.

Reporting a bug

If you discover a bug or what you believe is unintended behavior, please submit an issue on the issue board. A minimal working example and a short description of the context is appreciated and goes a long way towards being able to fix the problem quickly.

License

Lins is free software released under the MIT license.

Third-party dependencies

  • Nim's standard library
  • NimYAML
  • Regular expression support is provided by the PCRE library package, which is open source software, written by Philip Hazel, and copyright by the University of Cambridge, England.

Author

Lins is maintained by Marcus Eriksson.

About

Lins is a lightweight, extensible linter for prose—specifically developed with LaTeX in mind.

Resources

License

Stars

Watchers

Forks

Packages