StarMirror/MiniEngine
1
0
Fork 0
mirror of https://github.com/Kiritow/MiniEngine.git synced 2024-03-22 13:11:22 +08:00
Code Issues Projects Releases Wiki Activity

Update document

Browse Source
This commit is contained in:
Kirigaya Kazuto 2018-03-15 12:09:19 +08:00
parent 04d3b12c87
commit 4a23114b52
2 changed files with 66 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@ -2,34 +2,43 @@
A C++ Mini Engine. Based on SDL2.
[English Version](README_en_US.md)
C++编写的SDL2引擎.
**可能存在的错误**: 由于Event和Widget体系尚未构建完全，使用时可能出现问题(包括未解决的编译错误)。若只使用MiniEngine主体则不会出现问题。
**重要提示**: master分支为稳定分支,dev分支为开发分支.
### 编译说明
Windows/Linux: 请使用Codeblocks 16.01(推荐)载入所有.cpp文件.接下来Codeblocks会完成其余的工作.
> 依赖库
Windows: 推荐使用VS2017. 将项目克隆后加入解决方案, 注意删除`makefile_c4gen.cpp`以及`test`文件夹.
Linux: 请使用Codeblocks 17.12(推荐)载入所有文件.接下来Codeblocks会完成其余的工作.需要手动删除`makefile_c4gen.cpp`并排除`test`文件夹.
C4droid: 编译并运行`makefile_c4gen.cpp`,将生成一份makefile. 修改编译目标为SDL2 Application. 修改程序名称为program_name(也可以修改makefile为其他名称)
Windows,Linux需要以下依赖库:
> SDL2 (SDL2.lib, SDL2main.lib, SDL2test.lib)
> SDL2 Image (SDL2_image.lib)
> SDL2 Mixer (SDL2_mixer.lib)
> SDL2 TTF (SDL2_ttf.lib)
Linux Codeblocks PPA 参见: [Code::Blocks Release Builds](https://launchpad.net/~damien-moore/+archive/ubuntu/codeblocks-stable)
Windows-Visual Studio: 使用VS编译本项目可能会出现某些错误,目前还没有很好的解决办法.
C4droid: 使用Makefile Generator生成makefile文件. 选择编译目标为SDL2 Application. 修改程序名称为program_name(与makefile对应)
> 依赖库
C4droid需要保证已经安装以下应用:
> C4droid本体
> GCC Plugin For C4droid
> SDL2 Plugin For C4droid
[前往SDL2官网下载最新版本](http://www.libsdl.org/download-2.0.php)
[C4droid on GooglePlay](https://play.google.com/store/apps/details?id=com.n0n3m4.droidc&hl=en)
Linux Codeblocks PPA 参见: [Code::Blocks Release Builds](https://launchpad.net/~damien-moore/+archive/ubuntu/codeblocks-stable)
##### 依赖库下载地址
[SDL2_image下载地址](https://www.libsdl.org/projects/SDL_image/)
[SDL2_mixer下载地址](https://www.libsdl.org/projects/SDL_mixer/)
[SDL2_ttf下载地址](https://www.libsdl.org/projects/SDL_ttf/)
### 下载链接
[SDL2官网下载](http://www.libsdl.org/download-2.0.php)
[SDL2_image下载地址](https://www.libsdl.org/projects/SDL_image/)
[SDL2_mixer下载地址](https://www.libsdl.org/projects/SDL_mixer/)
[SDL2_ttf下载地址](https://www.libsdl.org/projects/SDL_ttf/)
[在GooglePlay上下载C4droid](https://play.google.com/store/apps/details?id=com.n0n3m4.droidc&hl=en "付费+需要科学上网")
[C4droid百度贴吧](http://tieba.baidu.com/f?kw=c4droid "虽然自从吧主换届之后大不如前...")

39
README_en_US.md Normal file
View File

@ -0,0 +1,39 @@
# MiniEngine
A C++ Mini Engine. Based on SDL2
### How to compile
Windows: Visual Studio 2017 is recommended. Import all files except `makefile_c4gen.cpp` and `test` directory.
Linux: Codeblocks 17.12 is recommended. Import all files except `makefile_c4gen.cpp` and `test` directory.
C4droid: Compile and run `makefile_c4gen.cpp`. Makefile will be generated. Then change make target to `SDL2 Application` and set the program name with `program_name`.
For Windows and Linux, the following libraries are required:
> SDL2 (SDL2.lib, SDL2main.lib, SDL2test.lib)
> SDL2 Image (SDL2_image.lib)
> SDL2 Mixer (SDL2_mixer.lib)
> SDL2 TTF (SDL2_ttf.lib)
For C4droid, the following packages are required:
> C4droid APP
> GCC Plugin For C4droid
> SDL2 Plugin For C4droid
This PPA is recommended for installing Code::Blocks in Linux: [Code::Blocks Release Builds](https://launchpad.net/~damien-moore/+archive/ubuntu/codeblocks-stable)
### Download Links
[SDL2 Official Download Website](https://www.libsdl.org/download-2.0.php)
[SDL2 Image Download](https://www.libsdl.org/projects/SDL_image/)
[SDL2 Mixer Download](https://www.libsdl.org/projects/SDL_mixer/)
[SDL2 TTF Download](https://www.libsdl.org/projects/SDL_ttf/)
[C4droid on GooglePlay](https://play.google.com/store/apps/details?id=com.n0n3m4.droidc&hl=en)