# README

We maintains the documents for MiniGUI Core and MiniGUI components in this repository.

MiniGUI aims to provide a fast, stable, full-featured, and cross-platform windowing and GUI support system, which is especially fit for embedded systems or smart IoT devices based-on Linux/uClinux, eCos, and other traditional RTOSes, such as RT-Thread, FreeRTOS, RTEMS, VxWorks, ThreadX, Nucleus, pSOS, uC/OS-II, OSE, and others.

This is the source tree of MiniGUI Core, which provides the windowing and graphics interfaces as well as a lot of standard controls (toolkit).

MiniGUI is released under GPLv3 and the dual-licensing applies to commercial use. In December 1998, the initiator of FMSoft, \[Vincent Wei], began to develop MiniGUI under the GNU General Public License (GPL). In September 2002, the core developers of MiniGUI founded \[FMSoft] and started the commercial marketing with the free software. By now, FMSoft still continues to release MiniGUI as a free software project.

For the live demos, source tarballs, and cases of MiniGUI, you can refer to the following website:

<http://www.minigui.com>

## Current Status

We have cleaned up the following documents:

* MiniGUI User Manual
* MiniGUI Programming Guide
* MiniGUI Supplementary Documents

## ChangeLog

* 2025-06-30\
  Update for MiniGUI version 5.0.16.\
  Tune the structure for GitBook.
* 2020-03-30\
  Links for MiniGUI API references of 5.0.0/4.0.7; Drafts of supplementary documents for MiniGUI 5.0.0.
* 2019-12-25\
  Draft of [Integrating with GPU](https://github.com/VincentWei/minigui-docs/blob/master/programming-guide/MiniGUIProgGuidePart3Chapter05.md)
* 2019-12-24\
  Tune for MiniGUI version 4.0.4.
* 2019-10-30\
  MiniGUI Programming Guide is ready.
* 2019-10-27\
  MiniGUI Supplementary Documents is ready.
* 2019-10-24\
  MiniGUI User Manual is ready.

## Links to Repositories

* [MiniGUI Core](https://github.com/VincentWei/minigui)
* [mGUtils](https://github.com/VincentWei/mgutils)
* [mGPlus](https://github.com/VincentWei/mgplus)
* [mGEff](https://github.com/VincentWei/mgeff)
* [mGNCS](https://github.com/VincentWei/mgncs)
* [mGNCS4Touch](https://github.com/VincentWei/mgncs4touch)
* [MiniGUI Demos](https://github.com/VincentWei/minigui-demos)

## 针对中文用户

很多中文开发者希望有中文文档。以前我们的确维护有中英文两个版本，但文档的维护工作量实在很大， 所以从 MiniGUI 3.2 版本开始，我们选择优先维护英文版本，中文版本就不再维护了。 这主要出于如下几个方面的因素考虑：

* 作为一个面向全球的开源软件，要服务所有国家或地区的开发者，英语是目前最好的语言。
* 使用英文，可以避免一些由于术语翻译不准确而导致的问题，对开发者理解工作原理会更有帮助。
* MiniGUI 各文档中使用的英文，不论是词汇还是语法，都相对简单，有一定基础的开发者都可以顺利阅读和理解。
* 现有基于大语言模型的翻译工具，已经能够替代人类完成技术文档的翻译工作。

另外，我们以前撰写的中文文档，仍保留在老的 MiniGUI Wiki 站点上，供参考：

<http://wiki.minigui.com/twiki/bin/view/Products/WebHome>

## Copying

Copyright © 2003 \~ 2025, [Beijing FMSoft Technologies Co., Ltd.](https://www.fmsoft.cn)\
All rights reserved.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://fmsoft.gitbook.io/minigui/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
