/NoTeX

A TeX editor made for students in Computer Science and Mathematics.

Primary LanguageRoffGNU General Public License v2.0GPL-2.0

NoTeX

NoTeX is a lightweight TeX editor made for Computer Science and Mathematics students. With a focus on fast and intuitive note-taking, NoTeX provides students with a way to visually see the TeX they are writing. It is written in C++, linking with the project pdf2svg to create Scalable Vector Graphics (SVGs) to allow resizing of individual LaTeX components. The GUI is written in GTKmm, a C++ API for GTK.

Installation and Setup

  1. Clone the repository onto your machine.

  2. Navigate into your cloned repository and create a build folder.

  3. Install the required dependencies:

Note that installation instructions of these dependencies may differ between operating systems.

  1. Navigate into your build directory and make the project using cmake ..; make.

  2. Run with ./NoTeX

Development

Interested in development? Great! Below are a set of instructions to quick start you into the development process. You can also join the Discord for communicating with other developers.

  1. Fork the repository.

  2. Clone your forked repository onto your machine.

  3. Navigate into your cloned repository and create a build folder.

  4. On top of the required dependencies listed above, you will also need:

  1. Navigate into your build directory and make the project using cmake ..; make.

  2. Run with ./NoTeX

Sharing your Contributions

Before submitting your code, make sure to check the Contribution Guidelines.

  1. Write your code into your local clone of your fork.

  2. Commit and push your changes to your fork.

  3. Go to the main repository and create a pull request. If you are unfamiliar, click on the "Pull Requests" tab and follow these instructions.