diff --git a/User-Manual-%28draft%29.md b/User-Manual-%28draft%29.md new file mode 100644 index 0000000..3c32100 --- /dev/null +++ b/User-Manual-%28draft%29.md @@ -0,0 +1,56 @@ +# User manual + +Welcome to LogarithmPlotter's user manual. Here, we'll cover most features of LogarithmPlotter and how to use them. + +## How LogarithmPlotter works +LogarithmPlotter is a software to create plots and graphs with a [logarithmic scale](https://en.wikipedia.org/wiki/Logarithmic_scale), the most well known kind being [Bode plots](https://en.wikipedia.org/wiki/Bode_plot), which LogarithmPlotter helps create in asymptotic form. While logarithmic scales in the primary interest of LogarithmPlotter, LogarithmPlotter also supports non logarithmic scales, which may be required to use certain features. + + +To do that, LogarithmPlotter uses a system called Objects, which may seem familiar to you if you have used other plotting software like [Geogebra](https://geogebra.org). + +An "object" is anything that can be reprensented on the graph. LogarithmPlotter allows you to create 9 types of objects: +- Points +- Texts (or labels) +- Functions +- Bode Magnitudes +- Bode Phases +- X Cursors (Cursors on the X scale) +- Sequences +- Distributions + +**Note**: In the case of sequences, it's recommended to use the non logarithmic scale. + +LogarithmPlotter will also create it's own objects automaticly when needed (for example, the sums of the bode gains and phases). + +## Interface +### First start +![Image of the first start screen of LogarithmPlotter](https://apps.ad5001.eu/img/en/logarithmplotter/welcome.png) + +When LogarithmPlotter starts for the first time or when it's been updated, you will be greeted by a screen similar to this one. It allows you to see the changelog, as well as configure the global options of LogarithmPlotter. + +- "Check for updates on startup" does exactly what it sounds like. If enabled, LogarithmPlotter will check if a new version has been released everytime it starts up. +- "Reset redo start when a new action is added to history": if disabled, if you go to a previous section of the [history](#History) and make a change, the more recent change won't be overwritten. + +Note that all of those settings can be changed at any moment from the "Settings" menu at the top of the window. + + +### Overview of the main interface +![Image of the main interface of LogarithmPlotter](https://apps.ad5001.eu/img/en/logarithmplotter/empty.png) +The main interface of LogarithmPlotter is divided into 2 sections, the side bar on the left, and the graph on the right. +The sidebar allows you to modify the diagram and interact with objects while the graph is where you see your changes and objects applied. + +The sidebar is composed of 3 tabs: Objects, Settings and History each of which will be explained in sections below. + +#### Objects +![Image of the objects tab in an example graph.](https://apps.ad5001.eu/img/en/logarithmplotter/objects.webp) + +The Object tabs allows you to interact, create and delete with the objects of the graph. + +#### Settings + +#### History + + +### Editing object properties +### Positioning objects +