Skip to content

Commit 4a23114

Browse files
committed
Update document
1 parent 04d3b12 commit 4a23114

File tree

2 files changed

+65
-17
lines changed

2 files changed

+65
-17
lines changed

README.md

+26-17
Original file line numberDiff line numberDiff line change
@@ -2,34 +2,43 @@
22

33
A C++ Mini Engine. Based on SDL2.
44

5+
[English Version](README_en_US.md)
6+
57
C++编写的SDL2引擎.
8+
9+
### 编译说明
610

7-
**可能存在的错误**: 由于Event和Widget体系尚未构建完全,使用时可能出现问题(包括未解决的编译错误)。若只使用MiniEngine主体则不会出现问题。
8-
**重要提示**: master分支为稳定分支,dev分支为开发分支.
11+
Windows: 推荐使用VS2017. 将项目克隆后加入解决方案, 注意删除`makefile_c4gen.cpp`以及`test`文件夹.
912

10-
### 编译说明
13+
Linux: 请使用Codeblocks 17.12(推荐)载入所有文件.接下来Codeblocks会完成其余的工作.需要手动删除`makefile_c4gen.cpp`并排除`test`文件夹.
14+
15+
C4droid: 编译并运行`makefile_c4gen.cpp`,将生成一份makefile. 修改编译目标为SDL2 Application. 修改程序名称为program_name(也可以修改makefile为其他名称)
16+
17+
Windows,Linux需要以下依赖库:
1118

12-
Windows/Linux: 请使用Codeblocks 16.01(推荐)载入所有.cpp文件.接下来Codeblocks会完成其余的工作.
13-
> 依赖库
1419
> SDL2 (SDL2.lib, SDL2main.lib, SDL2test.lib)
1520
> SDL2 Image (SDL2_image.lib)
1621
> SDL2 Mixer (SDL2_mixer.lib)
1722
> SDL2 TTF (SDL2_ttf.lib)
1823
19-
Linux Codeblocks PPA 参见: [Code::Blocks Release Builds](https://launchpad.net/~damien-moore/+archive/ubuntu/codeblocks-stable)
20-
21-
Windows-Visual Studio: 使用VS编译本项目可能会出现某些错误,目前还没有很好的解决办法.
22-
23-
C4droid: 使用Makefile Generator生成makefile文件. 选择编译目标为SDL2 Application. 修改程序名称为program_name(与makefile对应)
24-
> 依赖库
24+
C4droid需要保证已经安装以下应用:
25+
2526
> C4droid本体
2627
> GCC Plugin For C4droid
2728
> SDL2 Plugin For C4droid
2829
29-
[前往SDL2官网下载最新版本](http://www.libsdl.org/download-2.0.php)
30-
[C4droid on GooglePlay](https://play.google.com/store/apps/details?id=com.n0n3m4.droidc&hl=en)
30+
Linux Codeblocks PPA 参见: [Code::Blocks Release Builds](https://launchpad.net/~damien-moore/+archive/ubuntu/codeblocks-stable)
31+
32+
### 下载链接
33+
34+
[SDL2官网下载](http://www.libsdl.org/download-2.0.php)
35+
36+
[SDL2_image下载地址](https://www.libsdl.org/projects/SDL_image/)
37+
38+
[SDL2_mixer下载地址](https://www.libsdl.org/projects/SDL_mixer/)
39+
40+
[SDL2_ttf下载地址](https://www.libsdl.org/projects/SDL_ttf/)
41+
42+
[在GooglePlay上下载C4droid](https://play.google.com/store/apps/details?id=com.n0n3m4.droidc&hl=en "付费+需要科学上网")
3143

32-
##### 依赖库下载地址
33-
[SDL2_image下载地址](https://www.libsdl.org/projects/SDL_image/)
34-
[SDL2_mixer下载地址](https://www.libsdl.org/projects/SDL_mixer/)
35-
[SDL2_ttf下载地址](https://www.libsdl.org/projects/SDL_ttf/)
44+
[C4droid百度贴吧](http://tieba.baidu.com/f?kw=c4droid "虽然自从吧主换届之后大不如前...")

README_en_US.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# MiniEngine
2+
3+
A C++ Mini Engine. Based on SDL2
4+
5+
### How to compile
6+
7+
Windows: Visual Studio 2017 is recommended. Import all files except `makefile_c4gen.cpp` and `test` directory.
8+
9+
Linux: Codeblocks 17.12 is recommended. Import all files except `makefile_c4gen.cpp` and `test` directory.
10+
11+
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`.
12+
13+
For Windows and Linux, the following libraries are required:
14+
15+
> SDL2 (SDL2.lib, SDL2main.lib, SDL2test.lib)
16+
> SDL2 Image (SDL2_image.lib)
17+
> SDL2 Mixer (SDL2_mixer.lib)
18+
> SDL2 TTF (SDL2_ttf.lib)
19+
20+
For C4droid, the following packages are required:
21+
22+
> C4droid APP
23+
> GCC Plugin For C4droid
24+
> SDL2 Plugin For C4droid
25+
26+
This PPA is recommended for installing Code::Blocks in Linux: [Code::Blocks Release Builds](https://launchpad.net/~damien-moore/+archive/ubuntu/codeblocks-stable)
27+
28+
### Download Links
29+
30+
[SDL2 Official Download Website](https://www.libsdl.org/download-2.0.php)
31+
32+
[SDL2 Image Download](https://www.libsdl.org/projects/SDL_image/)
33+
34+
[SDL2 Mixer Download](https://www.libsdl.org/projects/SDL_mixer/)
35+
36+
[SDL2 TTF Download](https://www.libsdl.org/projects/SDL_ttf/)
37+
38+
[C4droid on GooglePlay](https://play.google.com/store/apps/details?id=com.n0n3m4.droidc&hl=en)
39+

0 commit comments

Comments
 (0)