README.md 3.57 KB
Newer Older
Vincent Wei's avatar
Vincent Wei committed
1 2 3 4
# MiniGUI Supplementary Documents

Good software requires good documentation, especially system software like
MiniGUI. However, maintaining documentation for a complex software system
Siyuan Tian's avatar
Siyuan Tian committed
5
is a lot more difficult than maintaining its source code.
Vincent Wei's avatar
Vincent Wei committed
6

Siyuan Tian's avatar
Siyuan Tian committed
7 8 9
It sounds like documents are always better than no documents,
but if the documents are outdated or containing errors, the damage will be
even greater. There is a saying "Source code is the best document."
Vincent Wei's avatar
Vincent Wei committed
10 11 12
Therefore, we don't particularly want to spend a lot of time writing and
maintaining documentation.

Siyuan Tian's avatar
Siyuan Tian committed
13
On the other hand, facing some new features, developers, especially
Vincent Wei's avatar
Vincent Wei committed
14
the beginners, still need some basic documents or guides to quickly
Siyuan Tian's avatar
Siyuan Tian committed
15
understand how these new features work and how to use them.
Vincent Wei's avatar
Vincent Wei committed
16 17 18 19 20

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
Siyuan Tian's avatar
Siyuan Tian committed
21
documents thoroughly just for the new features.
Vincent Wei's avatar
Vincent Wei committed
22

Siyuan Tian's avatar
Siyuan Tian committed
23 24 25 26
Therefore, we plan to write some new documents or guides on
GitHub Wiki, by supplementing the existing documents instead
of updating them. These documents are not be very detailed,
but will give the main points and related sample programs to
Vincent Wei's avatar
Vincent Wei committed
27 28 29 30
help you quickly grasp the relevant features.

We call these documents "MiniGUI Supplementary Documents".

31 32
## Features for Version 5.0.x

Vincent Wei's avatar
Vincent Wei committed
33 34
* [Write DRM Engine Driver for Your GPU](Writing-DRM-Engine-Driver-for-Your-GPU.md) -
    Write a DRM engine driver to exploit the hardware accelerating functions of your GPU.
35 36 37 38 39 40 41 42 43 44
* [Using Compositing Schema](Using-Compositing-Schema.md) -
    How to use compositing schema, and write a customized compositor.
* [Using Main Window Levels](Using-Main-Window-Levels.md) -
    How to use different main window levels for special main windows.
* [Using Virtual Window](Using-Virtual-Window.md) -
    Using virtual window for mulithreading applications.
* [Other Enhancements in MiniGUI 5.0](Other-Enhancements-in-MiniGUI-5.0.md) -
    How to use the other minor enhancements in MiniGUI 5.0.

## Features for Version 4.0.x
Vincent Wei's avatar
Vincent Wei committed
45

Vincent Wei's avatar
Vincent Wei committed
46
* [Write DRM Engine Driver for Your GPU](Writing-DRM-Engine-Driver-for-Your-GPU.md) -
47
    Write a DRM engine driver to exploit the hardware accelerating functions of your GPU.
Siyuan Tian's avatar
Siyuan Tian committed
48 49 50
* [Support and Use Extra Input Messages](Supporting-and-Using-Extra-Input-Messages.md) -
    Support and use extra input messages.
* [Use Enhanced Font Interfaces](Using-Enhanced-Font-Interfaces.md) -
Vincent Wei's avatar
Vincent Wei committed
51
    Understand and use enhanced font intefaces of MiniGUI 4.0.
Siyuan Tian's avatar
Siyuan Tian committed
52 53
* [Show Text in Complex/Mixed Scripts](Showing-Text-in-Complex-or-Mixed-Scripts.md) -
    Lay out, shape, and render text in complex or mixed scripts.
Vincent Wei's avatar
Vincent Wei committed
54 55 56

## Features for Version 3.2 or later

Siyuan Tian's avatar
Siyuan Tian committed
57 58
* [Use CommLCD NEWGAL Engine and Comm IAL Engine](Using-CommLCD-NEWGAL-Engine-and-Comm-IAL-Engine.md) -
    Define external stubs to implement your CommLCD engine and Comm
Vincent Wei's avatar
Vincent Wei committed
59
    IAL engine outside MiniGUI Core.
Siyuan Tian's avatar
Siyuan Tian committed
60 61
* [Use Images and Fonts on System without File System](Using-Images-and-Fonts-on-System-without-File-System.md) -
    Build source for incore images and fonts, and load them for
Vincent Wei's avatar
Vincent Wei committed
62
    your MiniGUI apps.
Siyuan Tian's avatar
Siyuan Tian committed
63 64 65
* [Use SyncUpdateDC to Reduce Screen Flicker](Using-SyncUpdateDC-to-Reduce-Screen-Flicker.md) -
    Use MiniGUI's synchronous update mechanism to reduce screen flicker.
* [Write MiniGUI Apps for 64-bit Platforms](Writing-MiniGUI-Apps-for-64-bit-Platforms.md) -
Vincent Wei's avatar
Vincent Wei committed
66 67
    Describe the things you need to be aware of when developing MiniGUI apps for 64-bit platforms.

Vincent Wei's avatar
Vincent Wei committed
68 69
## Copying

70 71
Copyright © 2003 \~ 2020, Beijing FMSoft Technologies Co., Ltd.  
All rights reserved.