tune

Vincent Wei
2019-04-17 16:00:07 +08:00
parent ee6aedc606
commit a41a26d8a5
+18 -15
@@ -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,
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, 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.
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
just for some new features.
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 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.
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".
@@ -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
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:
usage, concepts and APIs of MiniGUI. These documents are organized on the
old MiniGUI Wiki system or in PDF files:
* [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)
* [User Manual (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)
* [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.
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