-
Notifications
You must be signed in to change notification settings - Fork 19
Home.en US
The YSLib Project is a project of platform-neutral framework consists of several multi-licensed open source libraries. It is aiming to develop native applications in a naturally cross-platform manner.
See LICENSE.TXT in the source directory for licensing affairs.
The main part(except libraries not being maintained in this project) of the libraries is coded in C++, which is strictly conforming to ISO/IEC 14882. (For features being used, see here.)
It is currently in PreAlpha state. API may be not stable and ABI compatibility may not be retained between releases.
See here(zh-CN) for releases and plans.
- (Nintendo/iQue) DS (arm-none-eabi)
- using DeSmuME to run on PC
- MinGW32 (i686-w64-mingw32, compatible with i686-pc-mingw32)
- Android (arm-linux-androideabi)
- MinGW64 (x86_64-w64-mingw32)
- Linux32 (i686-linux-gnu)
- Linux64 (x86_64-linux-gnu)
Documentation of the code can be generated using Doxygen, see building documentation(zh-CN) .
Currently the Doxygen commands in the source code are mainly coded in simplified Chinese. It is planned to utilize Doxygen's ~[LanguageId] command to generate multilingual documents in future. All other comments, however, should be in English by default.
The document in /doc/vsd can be viewed by Microsoft Office Visio or Microsoft Visual Studio 2013.
Other non-generated documents are text files in the source repository, like Readme.zh-CN.txt & files in /doc, are intended to be used by the project maintainers.
This wiki is a project related to the YSLib project. They are currently the only two members in the same project group, each has separated repository. Both common documentation for the project group and general user documentation for the YSLib project are dominated by this wiki. Documentation in the YSLib project is mainly for maintainers. They are bidirectionally referenced, namely the content of this wiki may be refenenced in the YSLib project and vice versa.
Unless otherwise specified, the content of this wiki is fit for the current last master branch revision (i.e. the revision tip of master branch in the repository).
See here for rules to edit this wiki.
It is intended to reference every pages of this wiki in this page.
Contributions to the projects are welcomed. Provided materials thereby shall be adjusted by contributors (and the project maintainer) to conform the license of the corresponding projects if necessary.
Rules in this wiki are treated as consensus. Rules in project documentation have effect on maintainers but not other contributors. However, the contents in the projects shall always be conforming to the project rules.
To feedback or report issues, use BitBucket issue tracker, or contact the project maintainer as noted below.
The following philosophy are generally accommodated throughout the projects.
-
Do not reinvent the wheel. Projects here only accepts modular components which would be better elsewhere. Here "better" is defined as "superior than current solution in at least one aspect for consensually known need".
-
Decline premature optimization. However, what is "premature" is determined by the need, which would be probably variable.
- Mail to: [email protected]
- Post here (mainly zh-CN)