diff options
Diffstat (limited to 'fluid/documentation')
| -rw-r--r-- | fluid/documentation/src/fluid_flow_chart.png | bin | 0 -> 83226 bytes | |||
| -rw-r--r-- | fluid/documentation/src/fluid_flow_chart_800.png | bin | 0 -> 41559 bytes | |||
| -rw-r--r-- | fluid/documentation/src/index.dox | 6 | ||||
| -rw-r--r-- | fluid/documentation/src/page_build_integration.dox | 9 | ||||
| -rw-r--r-- | fluid/documentation/src/page_introduction.dox | 28 |
5 files changed, 41 insertions, 2 deletions
diff --git a/fluid/documentation/src/fluid_flow_chart.png b/fluid/documentation/src/fluid_flow_chart.png Binary files differnew file mode 100644 index 000000000..71d50e21c --- /dev/null +++ b/fluid/documentation/src/fluid_flow_chart.png diff --git a/fluid/documentation/src/fluid_flow_chart_800.png b/fluid/documentation/src/fluid_flow_chart_800.png Binary files differnew file mode 100644 index 000000000..1e5bd7c8a --- /dev/null +++ b/fluid/documentation/src/fluid_flow_chart_800.png diff --git a/fluid/documentation/src/index.dox b/fluid/documentation/src/index.dox index 9aa6ae033..8f05fb2b0 100644 --- a/fluid/documentation/src/index.dox +++ b/fluid/documentation/src/index.dox @@ -35,7 +35,7 @@ \subpage page_introduction - _not yet_ + - \ref introduction_workflow \subpage page_getting_started @@ -61,6 +61,10 @@ _not yet_ + \subpage page_build_integration + + _not yet_ + \subpage page_advanced _not yet_ diff --git a/fluid/documentation/src/page_build_integration.dox b/fluid/documentation/src/page_build_integration.dox new file mode 100644 index 000000000..4c895541e --- /dev/null +++ b/fluid/documentation/src/page_build_integration.dox @@ -0,0 +1,9 @@ +/** + + \page page_build_integration Integration into Build Systems + + \tableofcontents + + - Explain how to integrate code into FLUID, including code nodes and event handling. + + */ 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 . */ |
