diff --git a/README.md b/README.md index d22f5d5..1c92eeb 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,8 @@ zeus Instructions ============ -TODO ... +messaging engine drived by data and message based on websocket api + License (APACHE v2.0) ===================== diff --git a/doc/build.md b/doc/build.md new file mode 100644 index 0000000..aa04280 --- /dev/null +++ b/doc/build.md @@ -0,0 +1,118 @@ +Build lib & build sample {#zeus_build} +======================== + +@tableofcontents + +Download: {#zeus_build_download} +========= + +ege use some tools to manage source and build it: + +need google repo: {#zeus_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): {#zeus_build_download_lutin} +--------------------- + +```{.sh} + pip install lutin --user + # optionnal dependency of lutin (manage image changing size for application release) + pip install pillow --user +``` + + +dependency: {#zeus_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: {#zeus_build_download_sources} +-------- + +They are already download in the repo manifest in: + +```{.sh} + cd WORKING_DIRECTORY/framework/atria-soft/zeus +``` + +Build: {#zeus_build_build} +====== + +you must stay in zour working directory... +```{.sh} + cd WORKING_DIRECTORY +``` + +library: {#zeus_build_build_library} +-------- + +```{.sh} + lutin -mdebug zeus +``` + +Sample: {#zeus_build_build_sample} +------- + +```{.sh} + # generic gateway (with acces control) + lutin -mdebug zeus-gateway + # control acces with the user property + lutin -mdebug zeus-system-user + # simple picture service (example) + lutin -mdebug zeus-picture + # test service + lutin -mdebug zeus-test-service1 + # test client + lutin -mdebug zeus-test-client +``` + +A fast way: +```{.sh} + lutin -mdebug zeus-* +``` + + +Run sample: {#zeus_build_run_sample} +=========== + +you must copy a configuration file: + +```{.sh} + mkdir -p ~/.local/share/zeus-system-user/ + cp framework/atria-soft/zeus/test1#atria-soft.com.json ~/.local/share/zeus-system-user/test1~atria-soft.com.json +``` + +in distinct bash: +```{.sh} + lutin -mdebug zeus-gateway?run + lutin -mdebug zeus-system-user?run + lutin -mdebug zeus-picture?run + lutin -mdebug zeus-test-service1?run + lutin -mdebug zeus-test-client?run +``` diff --git a/doc/mainpage.md b/doc/mainpage.md new file mode 100644 index 0000000..45439e8 --- /dev/null +++ b/doc/mainpage.md @@ -0,0 +1,65 @@ +ZEUS library {#mainpage} +============= + +@tableofcontents + +What is ZEUS: {#zeus_mainpage_what} +============== + +ZEUS, or Zeus Ewol micro-service. It is a developement to create c++ microservice compatible with the web generic ineterface. + +My objective are: + - create a facebook, tweeter, snapsher heberged on my own server and not dependent on the "big enterprise" that I do not know what they do on my "PERSONAL DATA" + - Have a real sharing on personal picture and video with the circle I want + - Create a separate Front end that can acces on an other service that is own on an other server ==> generic API ==> 1 Front end + - shared My phone and personal data with all my friend and family ==> ne need to update the information, this is automatic... + - ... + +I love Free Internat that I can be free on big compagny !!!! + +What it does: {#zeus_mainpage_what_it_does} +------------- + +This is a prototype (need more developpers) + +TBD ... + +ZEUS is dependent of the STL (compatible with MacOs stl (CXX)) + + +What languages are supported? {#zeus_mainpage_language} +============================= + +ZEUS is written in C++. + + +Are there any licensing restrictions? {#zeus_mainpage_license_restriction} +===================================== + +ZEUS is **FREE software** and _all sub-library are FREE and staticly linkable !!!_ + + +License (APACHE-2.0) {#zeus_mainpage_license} +==================== + +Copyright ZEUS 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 + + + +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 {#zeus_mainpage_sub_page} +=========== + + - @ref zeus_build + - [**ewol coding style**](http://atria-soft.github.io/ewol/ewol_coding_style.html) + diff --git a/doxy_zeus.py b/doxy_zeus.py new file mode 100644 index 0000000..e8b7ec4 --- /dev/null +++ b/doxy_zeus.py @@ -0,0 +1,34 @@ +#!/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("zeus: Zeus ewol micro-service interface") + 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_depend([ + 'etk', + 'enet', + 'ememory', + 'eproperty' + ]) + my_module.add_exclude_symbols([ + '*operator<<*', + ]) + my_module.add_exclude_file([ + 'debug.h', + ]) + my_module.add_file_patterns([ + '*.h', + '*.md', + ]) + + return my_module \ No newline at end of file diff --git a/zeus/Service.h b/zeus/Service.h index 302138b..9084783 100644 --- a/zeus/Service.h +++ b/zeus/Service.h @@ -13,6 +13,9 @@ #include #include +/** + * @brief Main zeus library namespace + */ namespace zeus { /** * @brief