|
|
|
# MiniGUI Supplementary Documents
|
|
|
|
|
|
|
|
## Overview
|
|
|
|
|
|
|
|
Good software requires good documentation, especially system software like MiniGUI.
|
|
|
|
However, maintaining documentation for a complex software system is a lot more difficult
|
|
|
|
than maintaining source code.
|
|
|
|
|
|
|
|
It sounds like it is always better if there are documents than no documents,
|
|
|
|
but if the documents are outdated or contain errors, the damage will be even greater.
|
|
|
|
So there is a saying: "Source code is the best document."
|
|
|
|
|
|
|
|
On the other hand, in the face of new features, developers, especially beginners,
|
|
|
|
still need some basic documentation to quickly understand how they work and
|
|
|
|
how to use them.
|
|
|
|
|
|
|
|
In the past many years, we have accumulated a large number of MiniGUI documents,
|
|
|
|
including user manuals, programming guides and so on. With the releases of new
|
|
|
|
MiniGUI versions (like MiniGUI 3.2 and MiniGUI 4.0), it doesn't make much sense to
|
|
|
|
update or rewrite these documents just for some new features.
|
|
|
|
|
|
|
|
Therefore, we plan to write some new documents on this GitHub wiki system,
|
|
|
|
by supplementing the existing documents instead of updating the existing ones.
|
|
|
|
These documents will not be very detailed, but will point out the main points
|
|
|
|
and related sample programs to help you quickly grasp the relevant features.
|
|
|
|
|
|
|
|
We call these documents "MiniGUI Supplementary Documents".
|
|
|
|
|
|
|
|
## Existing Documents
|
|
|
|
|
|
|
|
Due to the stability of the MiniGUI APIs, developers can continue to refer to the contents of the existing documents to understand and learn the basic concepts and interfaces of MiniGUI. These documents are organized on the old MiniGUI Wiki system:
|
|
|
|
|
|
|
|
* [MiniGUI Overview](http://wiki.minigui.com/twiki/bin/view/Products/MiniGUIIntroEN)
|
|
|
|
* [Datasheet for MiniGUI V3.0.x](http://wiki.minigui.com/twiki/bin/view/Products/MiniGUIDSV30)
|
|
|
|
* [Programming Guide of MiniGUI V3.2](http://wiki.minigui.com/twiki/bin/view/Products/MiniGUIProgGuideV32)
|
|
|
|
|
|
|
|
On the other hand, the API reference manuals are always consistent with the source code and are released with the source code packages. Here are the links to the API reference manual of MiniGUI Core and components:
|
|
|
|
|
|
|
|
### API Reference for MiniGUI 4.0.0
|
|
|
|
|
|
|
|
* [MiniGUI 4.0 API Reference (MiniGUI-Processes mode)](http://www.minigui.com/doc-api-ref-minigui-procs-4.0.0/html/index.html) - The API reference for MiniGUI V4.0 multi-process runmode.
|
|
|
|
* MiniGUI 4.0 API Reference (MiniGUI-Threads mode) - The API reference for MiniGUI V4.0 multi-thread runmode.
|
|
|
|
* MiniGUI 4.0 API Reference (MiniGUI-Standalone mode) - The API reference for MiniGUI V4.0 standalone runmode.
|
|
|
|
* mGUtils 1.2 API Reference - The API reference for mGUtils V1.2.
|
|
|
|
* mGPlus 1.4 API Reference - The API reference for mGUtils V1.4.
|
|
|
|
* mGEff 1.2 API Reference - The API reference for mGEff V1.2.
|
|
|
|
* mGNCS 1.2 API Reference - The API reference for mGNCS V1.2.
|
|
|
|
* mGNCS 4Touch 1.2 API Reference - The API reference for mGNCS4Touch V1.2.
|
|
|
|
|
|
|
|
### API Reference for MiniGUI 3.2.2
|
|
|
|
|
|
|
|
|
|
|
|
### Release Notes |
