User guide

.gitignore

@@ -2,4 +2,7 @@
 build/*
 
 # Ignore environment configuration files
-.vscode/*
+.vscode/*
+
+# Ignore releases
+releases/*

README.md

@@ -1,3 +1,3 @@
 # math-converter
 
-A simple program to convert text representations of math expressions between different formats, such as Mathcad and LaTeX. 
+A simple program to convert text representations of math expressions between different formats, such as Mathcad and LaTeX. Originally conceived and written haphazardly in AutoHotkey during the writing of an engineering report at university, it has been reimagined in C++ with since-obtained knowledge to achieve greater code quality and improved modularity. While the original could only convert from Mathcad to LaTeX, the intention for the new math-converter is to be able to convert back and forth between several different plain-text representations of math.

userguide.md

@@ -0,0 +1,56 @@
+# User guide for math-converter-1.0.0
+
+## Hotkeys
+
+There is currently only one hotkey in math-converter: `CTRL + SHIFT + V`.
+This will attempt to convert plain text from the user's clipboard from the selected input math language to the selected output math language and then type it into the active window.
+
+## Supported math languages
+
+### Input
+
+List of supported math languages for input:
+
+- Mathcad
+
+When copying from Mathcad, be sure to copy from within a math field i.e. with the gray highlighting. Copying the entire or even several math fields with the blue highlighting is not compatible with math-converter.
+
+### Output
+
+List of supported math languages for output:
+
+- LaTeX
+
+## Supported math features
+
+While not all math syntax is supported, a variety of commonly-used features are implemented.
+Mathcad is the starting point for the program, and the feature set reflects this.
+
+- Addition, subtraction, multiplication and division
+- Root and power
+- Equality (evaluation, comparison and definition)
+- Inequality (not equal, less than, greater than, less than or equal, greater than or equal)
+- Parentheses
+- Trigonometric functions (sin, cos, tan, cot, arcsin, arccos, arctan, arccot, sinh, cosh, tanh, coth, sec, csc)
+- Factorial
+- Absolute value
+- Derivative and integral
+- Matrix
+- Vector product
+- Sum and product
+- Logical NOT, AND and OR
+- Variable, unit and function formatting
+- Text subscript
+- Degree symbol
+- Percentage
+- Range and step range
+- Element of
+
+## Configuration
+
+There are currently no configuration options.
+However, the supported input character set can be extended with additional, user-made `.json` files under `/resources/character-sets/`. 
+
+## Contact
+
+For inquiries regarding math-converter, contact the author via email on [[email protected]](mailto:[email protected]) or by message on Discord to `Thomas#5904`.