[DOC] better doc
This commit is contained in:
parent
0ff8ca484a
commit
6e7619a4e9
72
doc/build.md
Normal file
72
doc/build.md
Normal file
@ -0,0 +1,72 @@
|
||||
Build lib & build sample {#esignal_build}
|
||||
========================
|
||||
|
||||
@tableofcontents
|
||||
|
||||
Download: {#esignal_build_download}
|
||||
=========
|
||||
|
||||
esignal use some tools to manage source and build it:
|
||||
|
||||
lutin (build-system): {#esignal_build_download_lutin}
|
||||
---------------------
|
||||
|
||||
```{.sh}
|
||||
pip install lutin --user
|
||||
# optionnal dependency of lutin (manage image changing size for application release
|
||||
pip install pillow --user
|
||||
```
|
||||
|
||||
|
||||
dependency: {#esignal_build_download_dependency}
|
||||
-----------
|
||||
|
||||
```{.sh}
|
||||
mkdir framework
|
||||
cd framework
|
||||
git clone https://github.com/atria-soft/elog.git
|
||||
git clone https://github.com/atria-soft/etk.git
|
||||
git clone https://github.com/atria-soft/ememory.git
|
||||
cd ..
|
||||
```
|
||||
|
||||
sources: {#esignal_build_download_sources}
|
||||
--------
|
||||
|
||||
```{.sh}
|
||||
cd framework
|
||||
git clone https://github.com/atria-soft/esignal.git
|
||||
cd ..
|
||||
```
|
||||
|
||||
Build: {#esignal_build_build}
|
||||
======
|
||||
|
||||
|
||||
library: {#esignal_build_build_library}
|
||||
--------
|
||||
|
||||
```{.sh}
|
||||
lutin -mdebug esignal
|
||||
```
|
||||
|
||||
Sample: {#esignal_build_build_sample}
|
||||
-------
|
||||
|
||||
```{.sh}
|
||||
lutin -mdebug esignal-sample
|
||||
lutin -mdebug esignal-test
|
||||
```
|
||||
|
||||
Or simple:
|
||||
|
||||
```{.sh}
|
||||
lutin -mdebug esignal-*
|
||||
```
|
||||
|
||||
Run sample: {#esignal_build_run_sample}
|
||||
===========
|
||||
|
||||
```{.sh}
|
||||
lutin -mdebug esignal-sample?run
|
||||
```
|
@ -43,3 +43,12 @@ 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 {#eproperty_mainpage_sub_page}
|
||||
===========
|
||||
|
||||
- @ref esignal_build
|
||||
- @ref esignal_tutorial
|
||||
- [**ewol coding style**](http://atria-soft.github.io/ewol/ewol_coding_style.html)
|
||||
|
||||
|
||||
|
@ -12,14 +12,23 @@ def create(target, module_name):
|
||||
my_module.set_website_sources("http://github.com/atria-soft/" + module_name)
|
||||
my_module.add_path([
|
||||
module_name,
|
||||
"doc"
|
||||
"doc",
|
||||
])
|
||||
my_module.add_sample_path([
|
||||
"sample"
|
||||
"sample",
|
||||
])
|
||||
my_module.add_module_depend([
|
||||
'etk',
|
||||
'ememory'
|
||||
'ememory',
|
||||
])
|
||||
my_module.add_exclude_symbols([
|
||||
'*operator<<*',
|
||||
])
|
||||
my_module.add_exclude_file([
|
||||
'debug.h',
|
||||
])
|
||||
my_module.add_file_patterns([
|
||||
'*.h',
|
||||
'*.md',
|
||||
])
|
||||
|
||||
return my_module
|
Loading…
Reference in New Issue
Block a user