... | @@ -9,21 +9,24 @@ is a lot more difficult than maintaining source code. |
... | @@ -9,21 +9,24 @@ is a lot more difficult than maintaining source code. |
|
It sounds like it is always better if there are documents than no documents,
|
|
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
|
|
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."
|
|
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, in the face of new features, developers, especially
|
|
On the other hand, facing some new features, the developers, especially
|
|
beginners, still need some basic documentation to quickly understand
|
|
the beginners, still need some basic documents or guides to quickly
|
|
how they work and how to use them.
|
|
understand how they work and how to use them.
|
|
|
|
|
|
In the past many years, we have accumulated a large number of MiniGUI
|
|
In the past many years, we have accumulated a large number of MiniGUI
|
|
documents, including user manuals, programming guides and so on.
|
|
documents, including user manuals, programming guides and so on.
|
|
With the releases of new MiniGUI versions (like MiniGUI 3.2 and
|
|
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
|
|
MiniGUI 4.0), it doesn't make much sense to update or rewrite these
|
|
just for some new features.
|
|
documents throughout just for some new features.
|
|
|
|
|
|
Therefore, we plan to write some new documents on this GitHub Wiki system,
|
|
Therefore, we plan to write some new documents or guides on this
|
|
by supplementing the existing documents instead of updating the existing ones.
|
|
GitHub Wiki system, by supplementing the existing documents instead
|
|
These documents will not be very detailed, but will point out the main points
|
|
of updating the existing ones. These documents will not be very detailed,
|
|
and related sample programs to help you quickly grasp the relevant features.
|
|
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".
|
|
We call these documents "MiniGUI Supplementary Documents".
|
|
|
|
|
... | @@ -48,17 +51,17 @@ We call these documents "MiniGUI Supplementary Documents". |
... | @@ -48,17 +51,17 @@ We call these documents "MiniGUI Supplementary Documents". |
|
|
|
|
|
Due to the stability of the MiniGUI APIs, developers can continue to refer to
|
|
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
|
|
the contents of the existing documents to understand and learn the basic
|
|
concepts and interfaces of MiniGUI. These documents are organized on the
|
|
usage, concepts and APIs of MiniGUI. These documents are organized on the
|
|
old MiniGUI Wiki system:
|
|
old MiniGUI Wiki system or in PDF files:
|
|
|
|
|
|
* [MiniGUI Overview](http://wiki.minigui.com/twiki/bin/view/Products/MiniGUIIntroEN)
|
|
* [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)
|
|
* [Datasheet for MiniGUI 3.2 (PDF)](http://www.minigui.com/docs/MINIGUI-DATASHEET-3.2.pdf)
|
|
* [User Manual (PDF)](http://www.minigui.com/docs/MINIGUI-USER-MANUAL-V3.0-5E.pdf)
|
|
* [User Manual for MiniGUI 3.0 (PDF)](http://www.minigui.com/docs/MINIGUI-USER-MANUAL-V3.0-5E.pdf)
|
|
* [Programming Guide of MiniGUI V3.2](http://wiki.minigui.com/twiki/bin/view/Products/MiniGUIProgGuideV32)
|
|
* [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
|
|
On the other hand, the API reference manuals are always consistent with
|
|
the source code and are released with the source code packages.
|
|
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:
|
|
Here are the links to the API reference manual of MiniGUI Core and components.
|
|
|
|
|
|
### API Reference for MiniGUI Core
|
|
### API Reference for MiniGUI Core
|
|
|
|
|
... | | ... | |