summaryrefslogtreecommitdiff
path: root/fluid/documentation/src/page_introduction.dox
diff options
context:
space:
mode:
authorMatthias Melcher <github@matthiasm.com>2023-11-07 14:28:15 +0100
committerMatthias Melcher <github@matthiasm.com>2023-11-07 14:28:22 +0100
commit5667dfc51bc62619d9bf34261009494d6060a7ce (patch)
treeda1103a2355e8af51f2c68dea1394f75ee6ab699 /fluid/documentation/src/page_introduction.dox
parent90d77372540d6747921f3d1b6c2e0eed465f4069 (diff)
FLUID: More user documentation
Diffstat (limited to 'fluid/documentation/src/page_introduction.dox')
-rw-r--r--fluid/documentation/src/page_introduction.dox28
1 files changed, 27 insertions, 1 deletions
diff --git a/fluid/documentation/src/page_introduction.dox b/fluid/documentation/src/page_introduction.dox
index 417f9e5db..78d0e98fb 100644
--- a/fluid/documentation/src/page_introduction.dox
+++ b/fluid/documentation/src/page_introduction.dox
@@ -4,6 +4,32 @@
\tableofcontents
- - Provide an introduction that explains the purpose of the user manual and any prerequisites or system requirements.
+ The Fast Light User Interface Designer, or FLUID, is a graphical editor that
+ can produce ready to compile C++ source code and header files.
+
+ This user manual will introduce FLUID, starting with the installation process,
+ an overview of the main application window, and how to compile and run a
+ simple program. I will explain how to generate a more complex user interface
+ with three short tutorial, followed by some advanced subject like creating
+ integrated reusable widget classes. The appendices will sum up node types
+ and code generation in more detail.
+
+ \section introduction_workflow Workflow
+
+ FLUID has two modes of operation. When started from the shell without command
+ line arguments, or when launched from the desktop, FLUID will open in
+ interactive mode.
+
+ If FLUID is started from the command line with `-u`, `-c`, or `cs`, it will
+ not open any user interface, but instead behave like any shell-only tool that
+ can be easily integrated into Makefiles and build systems like CMake.
+
+ \image html fluid_flow_chart_800.png
+ \image latex fluid_flow_chart.png "" width=10cm
+
+ FLUID organization
+
+ More details on the command line arguments of FLUID can be found
+ in the chapter \ref page_build_integration .
*/