[DOC] update documentation
This commit is contained in:
parent
3a657071a6
commit
3798324d97
1
authors.txt
Normal file
1
authors.txt
Normal file
@ -0,0 +1 @@
|
|||||||
|
MR Edouard DUPIN <yui.heero@gmail.com>
|
96
doc/build.md
Normal file
96
doc/build.md
Normal file
@ -0,0 +1,96 @@
|
|||||||
|
Build lib & build sample {#ege_build}
|
||||||
|
========================
|
||||||
|
|
||||||
|
@tableofcontents
|
||||||
|
|
||||||
|
Download: {#ege_build_download}
|
||||||
|
=========
|
||||||
|
|
||||||
|
ege use some tools to manage source and build it:
|
||||||
|
|
||||||
|
need google repo: {#ege_build_download_repo}
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
see: http://source.android.com/source/downloading.html#installing-repo
|
||||||
|
|
||||||
|
On all platform:
|
||||||
|
```{.sh}
|
||||||
|
mkdir ~/.bin
|
||||||
|
PATH=~/.bin:$PATH
|
||||||
|
curl https://storage.googleapis.com/git-repo-downloads/repo > ~/.bin/repo
|
||||||
|
chmod a+x ~/.bin/repo
|
||||||
|
```
|
||||||
|
|
||||||
|
On ubuntu
|
||||||
|
```{.sh}
|
||||||
|
sudo apt-get install repo
|
||||||
|
```
|
||||||
|
|
||||||
|
On archlinux
|
||||||
|
```{.sh}
|
||||||
|
sudo pacman -S repo
|
||||||
|
```
|
||||||
|
|
||||||
|
lutin (build-system): {#ege_build_download_lutin}
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
```{.sh}
|
||||||
|
pip install lutin --user
|
||||||
|
# optionnal dependency of lutin (manage image changing size for application release)
|
||||||
|
pip install pillow --user
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
dependency: {#ege_build_download_dependency}
|
||||||
|
-----------
|
||||||
|
|
||||||
|
```{.sh}
|
||||||
|
mkdir -p WORKING_DIRECTORY/framework
|
||||||
|
cd WORKING_DIRECTORY/framework
|
||||||
|
repo init -u git://github.com/atria-soft/manifest.git
|
||||||
|
repo sync -j8
|
||||||
|
cd ../..
|
||||||
|
```
|
||||||
|
|
||||||
|
sources: {#ege_build_download_sources}
|
||||||
|
--------
|
||||||
|
|
||||||
|
They are already download in the repo manifest in:
|
||||||
|
|
||||||
|
```{.sh}
|
||||||
|
cd WORKING_DIRECTORY/framework/atria-soft/ege
|
||||||
|
```
|
||||||
|
|
||||||
|
Build: {#ege_build_build}
|
||||||
|
======
|
||||||
|
|
||||||
|
|
||||||
|
library: {#ege_build_build_library}
|
||||||
|
--------
|
||||||
|
|
||||||
|
```{.sh}
|
||||||
|
lutin -mdebug ege
|
||||||
|
```
|
||||||
|
|
||||||
|
Sample: {#ege_build_build_sample}
|
||||||
|
-------
|
||||||
|
|
||||||
|
```{.sh}
|
||||||
|
lutin -mdebug ege-sample-double-view
|
||||||
|
lutin -mdebug ege-sample-raytracing
|
||||||
|
lutin -mdebug ege-sample-collision
|
||||||
|
lutin -mdebug ege-sample-camera-position
|
||||||
|
lutin -mdebug ege-sample-mesh-creator
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
Run sample: {#ege_build_run_sample}
|
||||||
|
===========
|
||||||
|
|
||||||
|
```{.sh}
|
||||||
|
lutin -mdebug ege-sample-double-view?run
|
||||||
|
lutin -mdebug ege-sample-raytracing?run
|
||||||
|
lutin -mdebug ege-sample-collision?run
|
||||||
|
lutin -mdebug ege-sample-camera-position?run
|
||||||
|
lutin -mdebug ege-sample-mesh-creator?run
|
||||||
|
```
|
58
doc/mainpage.md
Normal file
58
doc/mainpage.md
Normal file
@ -0,0 +1,58 @@
|
|||||||
|
EGE library {#mainpage}
|
||||||
|
=============
|
||||||
|
|
||||||
|
@tableofcontents
|
||||||
|
|
||||||
|
What is EGE: {#ege_mainpage_what}
|
||||||
|
==============
|
||||||
|
|
||||||
|
EGE, or Ewol Game Engine. It is a prototype to lean how to use the bullet lib and how can I create a simple game engine.
|
||||||
|
|
||||||
|
What it does: {#ege_mainpage_what_it_does}
|
||||||
|
-------------
|
||||||
|
|
||||||
|
EGE does not do many things (not enouth dev time)
|
||||||
|
|
||||||
|
EGE is dependent of the STL (compatible with MacOs stl (CXX))
|
||||||
|
|
||||||
|
What it doesn't do: {#ege_mainpage_what_it_not_does}
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
a good game
|
||||||
|
|
||||||
|
What languages are supported? {#ege_mainpage_language}
|
||||||
|
=============================
|
||||||
|
|
||||||
|
EGE is written in C++.
|
||||||
|
|
||||||
|
|
||||||
|
Are there any licensing restrictions? {#ege_mainpage_license_restriction}
|
||||||
|
=====================================
|
||||||
|
|
||||||
|
EGE is **FREE software** and _all sub-library are FREE and staticly linkable !!!_
|
||||||
|
|
||||||
|
|
||||||
|
License (APACHE-2.0) {#ege_mainpage_license}
|
||||||
|
====================
|
||||||
|
|
||||||
|
Copyright EGE Edouard DUPIN
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
<http://www.apache.org/licenses/LICENSE-2.0>
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
|
|
||||||
|
|
||||||
|
Other pages {#ege_mainpage_sub_page}
|
||||||
|
===========
|
||||||
|
|
||||||
|
- @ref ege_build
|
||||||
|
- [**ewol coding style**](http://atria-soft.github.io/ewol/ewol_coding_style.html)
|
||||||
|
|
36
doxy_ege.py
Normal file
36
doxy_ege.py
Normal file
@ -0,0 +1,36 @@
|
|||||||
|
#!/usr/bin/python
|
||||||
|
import os
|
||||||
|
import doxy.module as module
|
||||||
|
import doxy.debug as debug
|
||||||
|
import doxy.tools as tools
|
||||||
|
|
||||||
|
def create(target, module_name):
|
||||||
|
my_module = module.Module(__file__, module_name)
|
||||||
|
my_module.set_version("version.txt")
|
||||||
|
my_module.set_title("Ewol Game engine (based on bullet lib)")
|
||||||
|
my_module.set_website("http://atria-soft.github.io/" + module_name)
|
||||||
|
my_module.set_website_sources("http://github.com/atria-soft/" + module_name)
|
||||||
|
my_module.add_path([
|
||||||
|
module_name,
|
||||||
|
"doc"
|
||||||
|
])
|
||||||
|
my_module.add_sample_path([
|
||||||
|
"sample"
|
||||||
|
])
|
||||||
|
my_module.add_depend([
|
||||||
|
'elog',
|
||||||
|
'etk',
|
||||||
|
'ememory'
|
||||||
|
])
|
||||||
|
my_module.add_exclude_symbols([
|
||||||
|
'*operator<<*',
|
||||||
|
])
|
||||||
|
my_module.add_exclude_file([
|
||||||
|
'debug.h',
|
||||||
|
])
|
||||||
|
my_module.add_file_patterns([
|
||||||
|
'*.h',
|
||||||
|
'*.md',
|
||||||
|
])
|
||||||
|
|
||||||
|
return my_module
|
@ -19,10 +19,10 @@ def get_compagny_name():
|
|||||||
return "atria-soft"
|
return "atria-soft"
|
||||||
|
|
||||||
def get_maintainer():
|
def get_maintainer():
|
||||||
return ["Mr DUPIN Edouard <yui.heero@gmail.com>"]
|
return "authors.txt"
|
||||||
|
|
||||||
def get_version():
|
def get_version():
|
||||||
return [0,2,"dev"]
|
return "version.txt"
|
||||||
|
|
||||||
def create(target, module_name):
|
def create(target, module_name):
|
||||||
my_module = module.Module(__file__, module_name, get_type())
|
my_module = module.Module(__file__, module_name, get_type())
|
||||||
|
1
version.txt
Normal file
1
version.txt
Normal file
@ -0,0 +1 @@
|
|||||||
|
0.2-dev
|
Loading…
x
Reference in New Issue
Block a user