From 5bb05ed3ace3668d8743105f7e201ddfb06f9f71 Mon Sep 17 00:00:00 2001 From: Vincent Wei Date: Tue, 24 Dec 2019 15:10:16 +0800 Subject: [PATCH] remove links and give link to minigui-docs --- Home.md | 112 ++-------------------------------------------------- _Sidebar.md | 18 ++------- 2 files changed, 7 insertions(+), 123 deletions(-) diff --git a/Home.md b/Home.md index b71b4e0..0c0c3df 100644 --- a/Home.md +++ b/Home.md @@ -1,111 +1,7 @@ -# MiniGUI Supplementary Documents +# MiniGUI Wiki -## Overview +_NOTE_ -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." -Therefore, we don't particularly want to spend a lot of time writing and -maintaining documentation. - -On the other hand, facing some new features, the developers, especially -the beginners, still need some basic documents or guides 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 throughout just for some new features. - -Therefore, we plan to write some new documents or guides 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". - -## Supplementary Documents - -### Features for Version 4.0 or later - -* [Release Notes for MiniGUI 4.0](Release-Notes-for-MiniGUI-4.0) - - Enhancements and changes of MiniGUI 4.0.x. -* [Writing DRI Engine Driver for Your GPU](Writing-DRI-Engine-Driver-for-Your-GPU) - - Writing a DRI engine driver to exploit the hardware accelerated functions of your GPU. -* [Supporting and Using Extra Input Messages](Supporting-and-Using-Extra-Input-Messages) - - Supporting and using extra input messages. -* [Using Enhanced Font Interfaces](Using-Enhanced-Font-Interfaces) - - Understand and use enhanced font intefaces of MiniGUI 4.0. -* [Showing Text in Complex/Mixed Scripts](Showing-Text-in-Complex-or-Mixed-Scripts) - - How to lay out, shape, and render text in complex or mixed scripts. - -### Features for Version 3.2 or later - -* [Release Notes for MiniGUI 3.2](Release-Notes-for-MiniGUI-3.2) - - Enhancements and changes of MiniGUI 3.2.x. -* [Using CommLCD NEWGAL Engine and Comm IAL Engine](Using-CommLCD-NEWGAL-Engine-and-Comm-IAL-Engine) - - How to define external stubs to implement your CommLCD engine and Comm - IAL engine outside MiniGUI Core. -* [Using Images and Fonts on System without File System](Using-Images-and-Fonts-on-System-without-File-System) - - How to build source for incore images and fonts, and load them for - your MiniGUI apps. -* [Using SyncUpdateDC to Reduce Screen Flicker](Using-SyncUpdateDC-to-Reduce-Screen-Flicker) - - How to use MiniGUI's synchronous update mechanism to reduce screen flicker. -* [Writing MiniGUI Apps for 64-bit Platforms](Writing-MiniGUI-Apps-for-64-bit-Platforms) - - Describe the things you need to be aware of when developing MiniGUI apps for 64-bit platforms. - -### Others - -* [FAQs in Chinese](FAQs-in-Chinese) - - FAQs in Chinese. - -## 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 -usage, concepts and APIs of MiniGUI. These documents are organized on the -old MiniGUI Wiki system or in PDF files: - -* [MiniGUI Overview](MiniGUI-Overview) -* [Datasheet for MiniGUI 3.2 (PDF)](http://www.minigui.com/docs/MINIGUI-DATASHEET-3.2.pdf) -* [User Manual for MiniGUI 3.0 (PDF)](http://www.minigui.com/docs/MINIGUI-USER-MANUAL-V3.0-5E.pdf) -* [Programming Guide of MiniGUI 3.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 at the same time. -Here are the links to the API reference manuals of MiniGUI Core and components. - -### API Reference for MiniGUI Core - -* [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)](http://www.minigui.com/doc-api-ref-minigui-ths-4.0.0/html/index.html) - The API reference for MiniGUI V4.0 multi-thread runmode. -* [MiniGUI 4.0 API Reference (MiniGUI-Standalone mode)](http://www.minigui.com/doc-api-ref-minigui-sa-4.0.0/html/index.html) - The API reference for MiniGUI V4.0 standalone runmode. -* [MiniGUI 3.2 API Reference (MiniGUI-Processes mode)](http://www.minigui.com/api_ref/minigui-3.2.0/procs/index.html) - The API reference for MiniGUI V3.2 multi-process runmode. -* [MiniGUI 3.2 API Reference (MiniGUI-Threads mode)](http://www.minigui.com/api_ref/minigui-3.2.0/ths/index.html) - The API reference for MiniGUI V3.2 multi-thread runmode. -* [MiniGUI 3.2 API Reference (MiniGUI-Standalone mode)](http://www.minigui.com/api_ref/minigui-3.2.0/sa/index.html) - The API reference for MiniGUI V3.2 standalone runmode. - - -### API Reference for MiniGUI Components - -* [mGUtils 1.2 API Reference](http://www.minigui.com/doc-api-ref-mgutils-1.2.2/html/index.html) - The API reference for mGUtils V1.2. -* [mGPlus 1.4 API Reference](http://www.minigui.com/doc-api-ref-mgplus-1.4.0/html/index.html) - The API reference for mGUtils V1.4. -* [mGEff 1.2 API Reference](http://www.minigui.com/doc-api-ref-mgeff-1.2.2/html/index.html) - The API reference for mGEff V1.2. -* [mGNCS 1.2 API Reference](http://www.minigui.com/doc-api-ref-mgncs-1.2.4/html/index.html) - The API reference for mGNCS V1.2. -* [mGNCS4Touch 1.2 API Reference](http://www.minigui.com/doc-api-ref-mgncs4touch-1.2.2/html/index.html) - The API reference for mGNCS4Touch V1.2. - - -### Links to Release Notes - -* [MiniGUI Core](https://github.com/VincentWei/minigui/blob/master/RELEASE-NOTES.md) -* [mGUtils](https://github.com/VincentWei/mgutils/blob/master/RELEASE-NOTES.md) -* [mGPlus](https://github.com/VincentWei/mgplus/blob/master/RELEASE-NOTES.md) -* [mGEff](https://github.com/VincentWei/mgeff/blob/master/RELEASE-NOTES.md) -* [mGNCS](https://github.com/VincentWei/mgncs/blob/master/RELEASE-NOTES.md) -* [mGNCS4Touch](https://github.com/VincentWei/mgncs4touch/blob/master/RELEASE-NOTES.md) +We have moved the MiniGUI documents to `minigui-docs` repo: + diff --git a/_Sidebar.md b/_Sidebar.md index e57b34c..93ab116 100644 --- a/_Sidebar.md +++ b/_Sidebar.md @@ -1,17 +1,5 @@ Quick links -* [MiniGUI Overview](MiniGUI-Overview) -* [Datasheet for MiniGUI 3.2 (PDF)](http://www.minigui.com/docs/MINIGUI-DATASHEET-3.2.pdf) -* [User Manual for MiniGUI 3.0 (PDF)](http://www.minigui.com/docs/MINIGUI-USER-MANUAL-V3.0-5E.pdf) -* [Programming Guide for MiniGUI 3.2](http://wiki.minigui.com/twiki/bin/view/Products/MiniGUIProgGuideV32) -* [MiniGUI 4.0 API Reference (MiniGUI-Processes mode)](http://www.minigui.com/doc-api-ref-minigui-procs-4.0.0/html/index.html) -* [MiniGUI 4.0 API Reference (MiniGUI-Threads mode)](http://www.minigui.com/doc-api-ref-minigui-ths-4.0.0/html/index.html) -* [MiniGUI 4.0 API Reference (MiniGUI-Standalone mode)](http://www.minigui.com/doc-api-ref-minigui-sa-4.0.0/html/index.html) -* [MiniGUI 3.2 API Reference (MiniGUI-Processes mode)](http://www.minigui.com/api_ref/minigui-3.2.0/procs/index.html) -* [MiniGUI 3.2 API Reference (MiniGUI-Threads mode)](http://www.minigui.com/api_ref/minigui-3.2.0/ths/index.html) -* [MiniGUI 3.2 API Reference (MiniGUI-Standalone mode)](http://www.minigui.com/api_ref/minigui-3.2.0/sa/index.html) -* [mGUtils 1.2 API Reference](http://www.minigui.com/doc-api-ref-mgutils-1.2.2/html/index.html) -* [mGPlus 1.4 API Reference](http://www.minigui.com/doc-api-ref-mgplus-1.4.0/html/index.html) -* [mGEff 1.2 API Reference](http://www.minigui.com/doc-api-ref-mgeff-1.2.2/html/index.html) -* [mGNCS 1.2 API Reference](http://www.minigui.com/doc-api-ref-mgncs-1.2.4/html/index.html) -* [mGNCS4Touch 1.2 API Reference](http://www.minigui.com/doc-api-ref-mgncs4touch-1.2.2/html/index.html) +* [MiniGUI Home](http://www.minigui.com/) +* [HybridOS Home](https://hybridos.fmsoft.cn/) +* [FMSoft Home](https://www.fmsoft.cn/)