alexxnica / qilin-app

Text editor for exact sciences with built-in LaTeX/KaTeX/AsciiMath support

Qilin Editor

Qilin is a free, open-source text editor developed for exact sciences in mind. It fully supports LaTeX, KaTeX and AsciiMath. Qilin works on each desktop platform - it is based on Chromium and Node.js, licensed under the BSD-3-Clause license.

Contributing

Bug reporting

We want contributing to Qilin to be fun, enjoyable, and educational for everyone. Changes and improvements are more than welcome! Feel free to fork and open a pull request. If you have found any issues, please report them here - they are being tracked on GitHub Issues.

License

Qilin was created and developed by Bartosz Łaniewski. The full list of contributors can be found here. Qilin's code is BSD-3-Clause licensed. We also provide an additional "patent" grant.

Development

We have prepared multiple commands to help you develop Qilin on your own. Don't forget to install all Node.js dependencies from npm. You will need a local copy of Node.js installed on your machine.

$ npm install

Usage

$ npm run <command>

List of commands

Command	Description
preapre	Compiles resources used by Qilin
build	Builds Qilin releases for macOS, Windows, Linux
watch	Runs Qilin application and re-compiles on changes
start	Runs Qilin application
clean	Deletes builds and caches
eslint	Fixes ESLinter errors

Note: In some cases, you might need to run those scripts with administrator privileges (sudo).

Installation

There are two ways to install Qilin. Please, refer to INSTALL.md file for more instructions. If you wonder how to work on Qilin or have other questions - check our Wiki.

Screenshots

All the screenshots can be found on Imgur. You can find some devblogs on my Youtube channel.