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.
-
Clone the repository onto your machine.
-
Navigate into your cloned repository and create a
build
folder. -
Install the required dependencies:
Note that installation instructions of these dependencies may differ between operating systems.
-
Navigate into your
build
directory and make the project usingcmake ..; make
. -
Run with
./NoTeX
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.
-
Clone your forked repository onto your machine.
-
Navigate into your cloned repository and create a
build
folder. -
On top of the required dependencies listed above, you will also need:
-
Navigate into your
build
directory and make the project usingcmake ..; make
. -
Run with
./NoTeX
Before submitting your code, make sure to check the Contribution Guidelines.
-
Write your code into your local clone of your fork.
-
Commit and push your changes to your fork.
-
Go to the main repository and create a pull request. If you are unfamiliar, click on the "Pull Requests" tab and follow these instructions.