diff --git a/build b/build index 4caa15d4..47b884d9 160000 --- a/build +++ b/build @@ -1 +1 @@ -Subproject commit 4caa15d4229361296e19cf4a734819079580eb3e +Subproject commit 47b884d9b2e3285878988ac99496c7c6a26fdceb diff --git a/doc/001_bases.bb b/doc/001_bases.bb index e69de29b..1576ea84 100644 --- a/doc/001_bases.bb +++ b/doc/001_bases.bb @@ -0,0 +1,16 @@ +== [center]EWOL: Bases[/center] == +__________________________________________________ + +To use ewol you need to know only C++ language. It could be usefull to know: +:** [b]Python[/b] for all build tool. +:** [b]git[/b] for all version management +:** [b]OpenGL-ES2[/b] if you want to create custum advenced widget. + +Basicly this library is designed to be platform abstract and work on all classicle platform : +: ** Linux (X11) +: ** Windows +: ** MacOs +: ** Andoid +: ** IOs + + diff --git a/doc/index.bb b/doc/index.bb index 465609c2..8a1139ff 100644 --- a/doc/index.bb +++ b/doc/index.bb @@ -1,15 +1,73 @@ -== Ewol library == +== [center]Ewol library[/center] == +__________________________________________________ -[b]Copyright :[/b] Edouard DUPIN -[b]License :[/b] BSD 3 clauses +`Ewol` (Edn Widget OpenGl Layer) is a [b]FREE software[/b]. [i]All sub-library are FREE and staticly linkable !!![/i] -Ewol is a basic graphic inteface for : +Ewol is a graphycal renderer with classical graphycs think. The main idea is to developpe a library compatible natively on: : ** Linux (X11) : ** Windows : ** MacOs : ** Andoid : ** IOs (in-progress) + +=== Copyright (c) === +2011, Edouard DUPIN + + +=== License (DSB) === +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions +are met: + +:** Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. +:** Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. +:** The name of the author may not be used to endorse or promote products derived from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + +== Sub library: == +=== License: === +:** [b][lib[etk | e-tk]][/b] : BSD 3 clauses +::** [b][lib[linearmath | Linear-Math]][/b] : z-lib (subset of bullet lib) +::** [b][lib[earchive | e-Archive]][/b] : BSD 3 clauses +:::** [b][lib[z | Z lib]][/b] : z-lib +:** [b][lib[egami | e-gami]][/b] : BSD 3 clauses +::** [b][lib[esvg | e-svg]][/b] : BSD 3 clauses +:::** [b][lib[agg | AGG]][/b] : BSD-like +::** [b][lib[png | libPNG]][/b] : PNG +:** [b][lib[portaudio | portaudio]][/b] : MIT +:** [b][lib[ogg | ogg]][/b] : BSD-like +:** [b][lib[freetype : Free-Type]][/b] : BSD-like +:** [b][lib[ejson | e-json]][/b] : BSD 3 clauses +:** [b][lib[exml | e-xml]][/b] : BSD 3 clauses + + +=== Description : === +==== Internal: ==== +:** [b][lib[etk | e-tk]][/b] : Generic toolkit to acces on file, standardize acces on string (for Android and MacOs) ... +:** [b][lib[earchive | e-Archive]][/b] : Generic access to a zip file (used to access on file on Android) +:** [b][lib[eggami | e-gami]][/b] : generic image accessor for PNG, svg and bmp image (might add some other type ...) +:** [b][lib[esvg | e-svg]][/b] : Generic SVG image parser and displayer +:** [b][lib[ejson | e-json]][/b] : JSON file access (read and write) +:** [b][lib[exml | e-xml]][/b] : XML file access (read and write) + +==== External: ==== +:** [b][lib[linearmath | Linear-Math]][/b] : bullet mathamatical sub lib (for using same vec3). +:** [b][lib[z | Z lib]][/b] : Clkassical zlib lib. +:** [b][lib[agg | AGG]][/b] : A c++ drawing lib. +:** [b][lib[png | libPNG]][/b] : the classical png display lib. +:** [b][lib[portaudio | portaudio]][/b] : The classical audio wrapper lib. +:** [b][lib[ogg | ogg]][/b] : The classical Ogg coder reader lib. +:** [b][lib[freetype | Free-Type]][/b] : The classicle true-type reader lib. + +==== Other workspace working library and programs ==== +:** [b][lib[edn | edn]][/b] : (Application in GPLv3) Edn is the main application using this lib and designed for (in the first time). This is a "Code editor". +:** [b][lib[ege | e-ge]][/b] : (library in BSDv3) Ewol Game engine is a wrapper on the the bullet physical engine and ewol renderer engin. this is in developpement for now (the simple objective is to produce game to make profitable all my work) +:** [b][lib[bullet | bullet]][/b] : the classical bullet library physical engine. + + diff --git a/doc/tutorial/000_Build.bb b/doc/tutorial/000_Build.bb new file mode 100644 index 00000000..1e6757c4 --- /dev/null +++ b/doc/tutorial/000_Build.bb @@ -0,0 +1,78 @@ +== [center]Ewol extract and build examples[/center] == +__________________________________________________ + + +=== Linux dependency packages === +[code style=shell] + sudo apt-get install g++ libgl1-mesa-dev zlib1g-dev libasound2-dev + # if you want to compile with clang : + sudo apt-get install clang + # For andoid compilation (jdk 7 does not work...) + sudo apt-get install javacc openjdk-6-jdk + # if you want to compile for windows : + sudo apt-get install mingw32 + # on 64 bits processor for compatibility + sudo apt-get install ia32-libs +[/code] + + +=== Download instructions === + +Download the software : +[code style=shell] + # create a working directory path + mkdir your_workspace_path + cd your_workspace_path + # clone ewol and all sub-library + git clone git://github.com/HeeroYui/ewol.git + cd ewol + git submodule init + git submodule update + cd .. + # clone the exemple repository + git clone git://github.com/HeeroYui/example.git +[/code] + +[note] +The full build tool documentation is availlable here : [[http://heeroyui.github.io/lutin/ | lutin]] +[/note] + +=== Common build instructions === + +Compile software in debug for the curent platform : +[code style=shell] + ./ewol/build/lutin.py -mdebug +[/code] + +You can specify the platform with: +[code style=shell] + ./ewol/build/lutin.py -mdebug -tAndroid +[/code] + +It coud be usefull to disable the package generation in local debug : +[code style=shell] + ./ewol/build/lutin.py -mdebug -p +[/code] + +Build with clang instead of gcc: +[code style=shell] + ./ewol/build/lutin.py -C -cclang +[/code] + +Display the build in color : +[code style=shell] + ./ewol/build/lutin.py -C -mdebug -p +[/code] + +Build in realease and install the program named 'edn' +[code style=shell] + ./ewol/build/lutin.py -C edn-install +[/code] + +To run an application you will find it directly on the out 'staging' tree : +[code style=shell] + ./out/Linux/debug/staging/clang/edn/usr/bin/edn +[/code] + + + diff --git a/doc/tutorial/001_HelloWord.bb b/doc/tutorial/001_HelloWord.bb index 6f067732..dc7e531c 100644 --- a/doc/tutorial/001_HelloWord.bb +++ b/doc/tutorial/001_HelloWord.bb @@ -1,4 +1,35 @@ -= The basis = +== [center]Tutorial 1: Hello Word[/center] == +__________________________________________________ -Ewol is a basic library designed for all [b]'modern'[/b] platform. -This is \ No newline at end of file + + + +=== Instructions === +download the software : +[code style=shell] + git clone git://github.com/HeeroYui/ewol.git + cd ewol + git submodule init + git submodule update +[/code] + + +Compile software and install : +[code style=shell] + For this you might use a project that create binaries or something else ... + Show http://github.com/HeeroYui/edn project +[/code] + + +=== Dependency packages === +[code style=shell] + sudo apt-get install g++ libgl1-mesa-dev zlib1g-dev libasound2-dev + # if you want to compile with clang : + sudo apt-get install clang + # For andoid compilation (jdk 7 does not work...) + sudo apt-get install javacc openjdk-6-jdk + # if you want to compile for windows : + sudo apt-get install mingw32 + # on 64 bits processor for compatibility + sudo apt-get install ia32-libs +[/code] \ No newline at end of file diff --git a/external/exml b/external/exml index f62fa76b..cf596edc 160000 --- a/external/exml +++ b/external/exml @@ -1 +1 @@ -Subproject commit f62fa76b0486e066dd39443f22d48626adf28804 +Subproject commit cf596edcd516cf659c9a68e614f335ee9eed1ed3